revenuewire/jackfruit-rest-sdk-php

v1.26 2017-11-06 22:53 UTC

This package is auto-updated.

Last update: 2024-11-08 15:02:00 UTC


README

This API does not represent the final product. Some of the APIs listed below are highly experimental and will likely change before the final release. They may come with crashes and bugs and may potentially cause data loss.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/revenuewire/jackfruit-rest-sdk-php.git"
    }
  ],
  "require": {
    "revenuewire/jackfruit-rest-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Authorization-JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Authorization-JWT', 'Bearer');
// Configure API key authorization: API-KEY
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\Api\AffiliateLinkerLinksApi();
$catalogFid = "catalogFid_example"; // string | Offer's catalog FID

try {
    $result = $api_instance->affiliateLinksGet($catalogFid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateLinkerLinksApi->affiliateLinksGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/rest/v1

Documentation For Models

Documentation For Authorization

API-KEY

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

JWT

  • Type: API key
  • API key parameter name: X-Authorization-JWT
  • Location: HTTP header

Author