README

Introduction

Receives real-time event callbacks from freight audit providers (currently Navix) and publishes them to Kafka for downstream processing.

Request Flow

Navix ──POST──▶ APIM ──validates key, stamps X-Tenant-Id──▶ Webhooks API ──publishes──▶ Kafka

Navix fires an HTTP callback when an event occurs (invoice created, dispute updated, etc.).
Azure API Management (APIM) authenticates the caller via subscription key or OAuth client credentials, then forwards the request with an X-Tenant-Id header identifying the tenant.
This service validates the tenant header, deserializes the Navix payload, maps it to a provider-agnostic domain event, and publishes it to a Kafka topic.
Downstream consumers (the Events function app) process the domain events asynchronously.

Authentication

This API does not use Entra ID / OAuth for inbound requests. Authentication is handled at the APIM layer.

All requests must include the X-Tenant-Id header. Requests without this header receive a 401 Unauthorized response.

When testing from Swagger UI, click the Authorize button and enter your tenant identifier in the X-Tenant-Id field.

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-tql-sdk:0.0.2"

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

"require": {
    "sdksio/apimatic-tql-sdk": "0.0.2"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-tql-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
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

The API client can be initialized as follows:

use FreightFinancialsWebhookIngestionApiLib\Logging\LoggingConfigurationBuilder;
use FreightFinancialsWebhookIngestionApiLib\Logging\RequestLoggingConfigurationBuilder;
use FreightFinancialsWebhookIngestionApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use FreightFinancialsWebhookIngestionApiLib\FreightFinancialsWebhookIngestionApiClientBuilder;

$client = FreightFinancialsWebhookIngestionApiClientBuilder::init()
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

sdksio / apimatic-tql-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Request Flow

Authentication

Install the Package

Initialize the API Client

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities