README

Introduction

RiskOS™ documentation site is Socure confidential and proprietary information, and is only intended for viewing by authorized persons.

The Socure RiskOS™ APIs provide a unified API framework for risk evaluation. They use predictable, resource-oriented URLs, accept JSON-formatted request bodies, return JSON-formatted responses, and follow standard HTTP methods, status codes, and authentication practices.

You can test RiskOS™ APIs in the Sandbox environment, which allows you to simulate requests without impacting live data. The request endpoint determines whether the request is directed to the Sandbox or Production (live) environment.

Install the Package

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

composer require "sc-apimatic/sc-apimatic-sdk:0.0.2"

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

"require": {
    "sc-apimatic/sc-apimatic-sdk": "0.0.2"
}

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

The API client can be initialized as follows:

use SocureRiskOsApiLib\Logging\LoggingConfigurationBuilder;
use SocureRiskOsApiLib\Logging\RequestLoggingConfigurationBuilder;
use SocureRiskOsApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use SocureRiskOsApiLib\Environment;
use SocureRiskOsApiLib\Authentication\BearerAuthCredentialsBuilder;
use SocureRiskOsApiLib\SocureRiskOsApiClientBuilder;

$client = SocureRiskOsApiClientBuilder::init()
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->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 Production server (versioned)
ENVIRONMENT2	Sandbox server (for testing and development, versioned)

sc-apimatic / sc-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