README

Introduction

Orb's API is built with the following principles in mind:

Predictable developer experience: Where applicable, the Orb API uses industry-standard patterns such as cursor-based pagination and standardized error output. To help with debugging in critical API actions, the API always strives to provide detailed and actionable error messages. Aliases such as external customer IDs aid in fast integration times.
Reliably real time: Orb's event-based APIs, such as event ingestion are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event-level credits ledger and a highly performant webhooks architecture.
Flexibility at the forefront: Features like timezone localization and the ability to amend historical usage show the flexible nature of the platform.

You can download the latest OpenAPI spec here - pass ?version=3.0 for an OpenAPI 3.0-compatible spec.

Install the Package

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

composer require "orb-apimatic/orb-apiamtic-sdk:0.0.1"

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

"require": {
    "orb-apimatic/orb-apiamtic-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/orb-apimatic/orb-apiamtic-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
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
bearerAuthCredentials	`BearerAuthCredentials`	The Credentials Setter for OAuth 2 Bearer token

The API client can be initialized as follows:

use ApiReferenceLib\Logging\LoggingConfigurationBuilder;
use ApiReferenceLib\Logging\RequestLoggingConfigurationBuilder;
use ApiReferenceLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use ApiReferenceLib\Authentication\BearerAuthCredentialsBuilder;
use ApiReferenceLib\ApiReferenceClientBuilder;

$client = ApiReferenceClientBuilder::init()
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

orb-apimatic / orb-apiamtic-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities