README

Introduction

NewStore public APIs

Install the Package

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

composer require "newstore-apimatic/newstore-apimatic-sdk:0.0.1"

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

"require": {
    "newstore-apimatic/newstore-apimatic-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/newstore-apimatic/newstore-apimatic-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
tenant	`string`	Default: `'dodici'`
environment	`Environment`	The API environment. Default: `Environment.STAGING`
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
clientCredentialsAuth	`ClientCredentialsAuth`	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

use NewStoreAPILib\Environment;
use NewStoreAPILib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use NewStoreAPILib\Models\OAuthScopeEnum;
use NewStoreAPILib\NewStoreAPIClientBuilder;

$client = NewStoreAPIClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oAuthScopes(
                [
                    OAuthScopeEnum::CATALOGIMPORT_SCHEMASREAD,
                    OAuthScopeEnum::CATALOGIMPORT_SCHEMASWRITE
                ]
            )
    )
    ->environment(Environment::STAGING)
    ->tenant('dodici')
    ->build();

Environments

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

Fields

Name	Description
STAGING	Default

newstore-apimatic / newstore-apimatic-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities