sdksio/apimatic-sdk

Use APIMatic API to generate SDKs in Python, Typescript, PHP, Ruby, and GO. You can generate On-Prem portal and many more.

Maintainers

Details

github.com/sdks-io/apimatic-php-sdk

Homepage

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

3.0.0 2024-04-08 15:19 UTC

Requires

Requires (Dev)

MIT 3dd90bfc2d51b929fbdb7558d475e6f0a1194d72

apisdkapimatic

This package is not auto-updated.

Last update: 2024-04-23 14:07:49 UTC

README

Introduction

This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine

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-sdk:3.0.0"

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

"require": {
    "sdksio/apimatic-sdk": "3.0.0"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-sdk#3.0.0

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

  1. First install the dependencies using composer including the require-dev dependencies.
  2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

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, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry array Http methods to retry against.
Default: 'GET', 'PUT', 'GET', 'PUT'
customHeaderAuthenticationCredentials CustomHeaderAuthenticationCredentials The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

$client = ApimaticAPIClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'Authorization'
        )
    )
    ->build();

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation