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:

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.

• ApiKey (Custom Header Signature)
• BearerAuth (OAuth 2 Bearer token)

List of APIs

• Orders

Webhooks

• Webhooks
• Webhooks A
• Webhooks B
• Webhooks C
• Webhooks No Verification

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse