README

Install the Package

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

composer require "zahratest273/project2:1.1.1"

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

"require": {
    "zahratest273/project2": "1.1.1"
}

You can also view the package at: https://packagist.org/packages/zahratest273/project2#1.1.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
`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'`
`basicCredentials`	`BasicCredentials`	The Credentials Setter for Basic Authentication
`oAuth2Credentials`	`OAuth2Credentials`	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

$client = Form3PublicAPIClientBuilder::init()
    ->basicCredentials(
        BasicCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->oAuth2Credentials(
        OAuth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->build();

Authorization

This API uses the following authentication schemes.

zahratest273 / project2

Maintainers

Details

README

Install the Package

Initialize the API Client

Authorization

List of APIs

Classes Documentation