gallagher-suarez-traders / wesley-key-sdkabc
Omnis nisi cumque si
Package info
github.com/ZahraN444/wesley-key-sdk
pkg:composer/gallagher-suarez-traders/wesley-key-sdkabc
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
A comprehensive API demonstrating webhooks and callbacks patterns.
Webhooks
Webhooks allow your application to receive real-time notifications when certain events occur.
Callbacks
Callbacks are used for asynchronous operations where the API will call back to your provided URL when the operation completes.
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "gallagher-suarez-traders/wesley-key-sdkabc:4.0.0"
Or add it to the composer.json file manually as given below:
"require": { "gallagher-suarez-traders/wesley-key-sdkabc": "4.0.0" }
You can also view the package at: https://packagist.org/packages/gallagher-suarez-traders/wesley-key-sdkabc#4.0.0
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: 50 |
| 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' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| apiKeyCredentials | ApiKeyCredentials |
The Credentials Setter for Custom Header Signature |
| bearerAuthCredentials | BearerAuthCredentials |
The Credentials Setter for OAuth 2 Bearer token |
The API client can be initialized as follows:
use WebhooksAndCallbacksAPILib\Logging\LoggingConfigurationBuilder; use WebhooksAndCallbacksAPILib\Logging\RequestLoggingConfigurationBuilder; use WebhooksAndCallbacksAPILib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use WebhooksAndCallbacksAPILib\Authentication\ApiKeyCredentialsBuilder; use WebhooksAndCallbacksAPILib\Authentication\BearerAuthCredentialsBuilder; use WebhooksAndCallbacksAPILib\WebhooksAndCallbacksAPIClientBuilder; $client = WebhooksAndCallbacksAPIClientBuilder::init() ->apiKeyCredentials( ApiKeyCredentialsBuilder::init( 'X-API-Key' ) ) ->bearerAuthCredentials( BearerAuthCredentialsBuilder::init( 'AccessToken' ) ) ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
Authorization
This API uses the following authentication schemes.
List of APIs
Webhooks
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder