README

Introduction

The Assets API enables users to retrieve information related to assets. It enables users to query the search identifiers and query assets based on different criteria. The Asset APIs enable users to create new asset requests, edit or delete current asset requests, as well as check the status of their requests.

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-fis-assets-sdk:0.0.1"

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

"require": {
    "sdksio/apimatic-fis-assets-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-fis-assets-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: `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
bearerCredentials	`BearerCredentials`	The Credentials Setter for Custom Header Signature
mDefaultCredentials	`MDefaultCredentials`	The Credentials Setter for OAuth 2 Implicit Grant

The API client can be initialized as follows:

use AssetMasterServicesAssetsLib\Logging\LoggingConfigurationBuilder;
use AssetMasterServicesAssetsLib\Logging\RequestLoggingConfigurationBuilder;
use AssetMasterServicesAssetsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use AssetMasterServicesAssetsLib\Environment;
use AssetMasterServicesAssetsLib\Authentication\BearerCredentialsBuilder;
use AssetMasterServicesAssetsLib\Authentication\MDefaultCredentialsBuilder;
use AssetMasterServicesAssetsLib\AssetMasterServicesAssetsClientBuilder;

$client = AssetMasterServicesAssetsClientBuilder::init()
    ->bearerCredentials(
        BearerCredentialsBuilder::init(
            'Authorization'
        )
    )
    ->mDefaultCredentials(
        MDefaultCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthRedirectUri'
        )
    )
    ->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
ENVIRONMENT2	-

sdksio / apimatic-fis-assets-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