ApimatictqlSDK 0.0.2

Getting Started with Freight Financials — Webhook Ingestion API

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

1. Navix fires an HTTP callback when an event occurs (invoice created, dispute updated, etc.).
2. 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.
3. 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.
4. 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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimatictqlSDK --version 0.0.2

You can also view the package at: https://www.nuget.org/packages/ApimatictqlSDK/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:

The API client can be initialized as follows:

Code-Based Initialization

using FreightFinancialsWebhookIngestionApi.Standard;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

FreightFinancialsWebhookIngestionApiClient client = new FreightFinancialsWebhookIngestionApiClient.Builder()
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using FreightFinancialsWebhookIngestionApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = FreightFinancialsWebhookIngestionApiClient
    .FromConfiguration(configuration.GetSection("FreightFinancialsWebhookIngestionApi"));

See the Configuration-Based Initialization section for details.

List of APIs

• Assignments
• Documents
• Freight Audit
• Invoices
• Loads
• Rating

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter