sdksio/apimatic-sticky-apis-sdk

This is a test SDK generated by APIMatic

Maintainers

Package info

github.com/sdks-io/apimatic-sticky-apis-php-sdk

Homepage

pkg:composer/sdksio/apimatic-sticky-apis-sdk

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

0.0.1 2026-04-20 11:12 UTC

Requires

Requires (Dev)

MIT d0f82df5637589d72b7a04b87d2fa34416cb6ca7

  • developer sdksio <developer+sdksio.woop@apimatic.io>

apimaticsdksio

This package is auto-updated.

Last update: 2026-04-20 11:13:36 UTC

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:

Field Data Type Description
status String Status of the API call. "SUCCESS" or "FAILURE" are possible values.
data Mixed Data returned by API call. It could be an object or an array of objects.

List Responses

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

Field Data Type Description
status String Status of the API call. "SUCCESS" or "FAILURE" are possible values.
data Mixed Data returned by API call. It could be an object or an array of objects.
current_page Integer Current page associated with the dataset returned in data.
first_page_url String URL that maps to the first paginated list of a given entity.
last_page Integer Number of pages in a given dataset.
last_page_url String URL that maps to the last paginated list of a given entity.
next_page_url String URL that maps to the next paginated list of a given entity.
path String URL that maps to the index page of a given entity.
per_page Mixed Data returned by API call. It could be an object or an array of objects.
prev_page_url Mixed Data returned by API call. It could be an object or an array of objects.
from Integer Offset record number lower bound.
to Mixed Offset record number upper bound.
total Integer Total amount of records that exist for a given entity.

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:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
timeout int Timeout for API calls in seconds.
Default: 0
enableRetries bool Whether to enable retries and backoff feature.
Default: false
numberOfRetries int The number of retries to make.
Default: 0
retryInterval float The retry time interval between the endpoint calls.
Default: 1
backOffFactor float Exponential backoff factor to increase interval between retries.
Default: 2
maximumRetryWaitTime int The maximum wait time in seconds for overall retrying requests.
Default: 0
retryOnTimeout bool Whether to retry on request timeout.
Default: true
httpStatusCodesToRetry array Http status codes to retry against.
Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry array Http methods to retry against.
Default: 'GET', 'PUT'
loggingConfiguration LoggingConfigurationBuilder Represents the logging configurations for API calls
proxyConfiguration ProxyConfigurationBuilder Represents the proxy configurations for API calls
basicCredentials BasicCredentials The Credentials Setter for Basic Authentication
bearerCredentials BearerCredentials The Credentials Setter for OAuth 2 Bearer token

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

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities