README

Introduction

sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON. The authorization used is Basic Authentication

Version 1 JSON API

Requests

API requests that call for a request body are expected to be in JSON Format.

Responses

The v2 standard JSON responses will usually contain at least the following:

List Responses

GET requests that return a list of entities will usually contain the following:

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "sdksio/apimatic-sticky-apis-sdk:0.0.1"

Or add it to the composer.json file manually as given below:

"require": {
    "sdksio/apimatic-sticky-apis-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-sticky-apis-sdk#0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

use StickyIoRestfulApiV2025731Lib\Logging\LoggingConfigurationBuilder;
use StickyIoRestfulApiV2025731Lib\Logging\RequestLoggingConfigurationBuilder;
use StickyIoRestfulApiV2025731Lib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use StickyIoRestfulApiV2025731Lib\Environment;
use StickyIoRestfulApiV2025731Lib\Authentication\BasicCredentialsBuilder;
use StickyIoRestfulApiV2025731Lib\Authentication\BearerCredentialsBuilder;
use StickyIoRestfulApiV2025731Lib\StickyIoRestfulApiV2025731ClientBuilder;

$client = StickyIoRestfulApiV2025731ClientBuilder::init()
    ->basicCredentials(
        BasicCredentialsBuilder::init(
            'username',
            'password'
        )
    )
    ->bearerCredentials(
        BearerCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• basic (Basic Authentication)
• bearer (OAuth 2 Bearer token)

List of APIs

• Billing Models
• Campaigns
• Payment Types Methods
• Promo Codes
• Custom Fields
• Start Stop Reset
• Line Item Custom Options
• Line Item Management
• Trial Workflows
• Payment Router
• Volume Discounts
• Permissions
• Affiliates
• Meta
• Addresses
• Wallet
• Interests
• Communications
• Contacts
• Coupons
• Customers
• Gateways
• Images
• Types
• Templates
• Notes
• Products
• Discount
• Credits
• Overrides
• Subscriptions
• Orders
• Configurations
• Offers
• Attributes
• Categories
• Variants
• Prospects
• Shipping
• Tokenization
• Users
• Chargeback
• Inventories
• Warehouse
• Order
• Subscription
• Misc

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• FileWrapper
• ApiResponse