Getting Started with splitit-web-api-v4

Introduction

Splitit Orchestration API for managing installment plans.

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-splitit-sdk:1.0.2"

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

"require": {
    "sdksio/apimatic-splitit-sdk": "1.0.2"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-splitit-sdk#1.0.2

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_ENVIRONMENT
timeout	int	Timeout for API calls in seconds. Default: 30
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
oauth2Credentials	Oauth2Credentials	The Credentials Setter for OAuth 2 Client Credentials Grant
apiKeyCredentials	ApiKeyCredentials	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

use SplititWebApiV4Lib\Logging\LoggingConfigurationBuilder;
use SplititWebApiV4Lib\Logging\RequestLoggingConfigurationBuilder;
use SplititWebApiV4Lib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use SplititWebApiV4Lib\Environment;
use SplititWebApiV4Lib\Authentication\Oauth2CredentialsBuilder;
use SplititWebApiV4Lib\Models\OauthScopeOauth2;
use SplititWebApiV4Lib\Authentication\ApiKeyCredentialsBuilder;
use SplititWebApiV4Lib\SplititWebApiV4ClientBuilder;

$client = SplititWebApiV4ClientBuilder::init()
    ->oauth2Credentials(
        Oauth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScopeOauth2::API_V4
                ]
            )
    )
    ->apiKeyCredentials(
        ApiKeyCredentialsBuilder::init(
            'X-Splitit-Api-Key'
        )
    )
    ->environment(Environment::PRODUCTION_ENVIRONMENT)
    ->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_ENVIRONMENT	Default
SANDBOX_ENVIRONMENT	-

Authorization

This API uses the following authentication schemes.

• OAuth2 (OAuth 2 Client Credentials Grant)
• ApiKey (Custom Header Signature)

List of APIs

• Installment Plan

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse