Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "splitit/splitit-php-sdk:0.0.51"Or add it to the composer.json file manually as given below:
"require": {
"splitit/splitit-php-sdk": "0.0.51"
}You can also view the package at: https://packagist.org/packages/splitit/splitit-php-sdk#0.0.51
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-devdependencies. - Run
vendor\bin\phpunit --verbosefrom commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verboseinstead.
You can change the PHPUnit test configuration in the phpunit.xml file.
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' |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| oAuth2SandboxCredentials | OAuth2SandboxCredentials |
The Credentials Setter for OAuth 2 Client Credentials Grant |
| oAuth2ProductionCredentials | OAuth2ProductionCredentials |
The Credentials Setter for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
use SplititWebApiV3Lib\Environment;
use SplititWebApiV3Lib\Authentication\OAuth2SandboxCredentialsBuilder;
use SplititWebApiV3Lib\Models\OAuthScopeOAuth2SandboxEnum;
use SplititWebApiV3Lib\Authentication\OAuth2ProductionCredentialsBuilder;
use SplititWebApiV3Lib\Models\OAuthScopeOAuth2ProductionEnum;
use SplititWebApiV3Lib\SplititWebApiV3ClientBuilder;
$client = SplititWebApiV3ClientBuilder::init()
->oAuth2SandboxCredentials(
OAuth2SandboxCredentialsBuilder::init(
'OAuthClientId',
'OAuthClientSecret'
)
->oAuthScopes(
[
OAuthScopeOAuth2SandboxEnum::API_V3
]
)
)
->oAuth2ProductionCredentials(
OAuth2ProductionCredentialsBuilder::init(
'OAuthClientId',
'OAuthClientSecret'
)
->oAuthScopes(
[
OAuthScopeOAuth2ProductionEnum::API_V3
]
)
)
->environment(Environment::PRODUCTION)
->build();The SDK can be configured to use a different environment for making API calls. Available environments are:
| Name | Description |
|---|---|
| production | Default Sandbox |
| environment2 | Production |
This API uses the following authentication schemes.