Link API

Choose the built-in API that matches your integration:

Task

Guide

Submit messages to Link or collect outgoing messages

Inbox / Outbox versions and the existing Inbox/Outbox v3 guide

Upload or replace DLL, schema, and XSLT artifacts

Artifact Upload API

Track and log a flow controlled outside Link, with configured error handling

External Flow Tracking APIs , with Tracking API and Async Tracking API as its interface guides

Return an external processing result to a Link-managed itinerary

Async Flow API

Retrieve a known document's metadata and related entities

Document API

Read settings and document-related configuration values

Configuration API

Look up conversion-table rows

Conversion Table API

Apply an exported Link configuration

Configuration Import API

Start with [API conventions](api-conventions.md) for environment URLs, authentication links, shared terms, and error handling. Open /api/swagger/index.html in your own environment and select the relevant definition to inspect the installed contract.

.NET client library

If your client is written in .NET, we recommend using the Bizbrains.Link.Api.Proxy NuGet package for the supported Link APIs. It provides .NET proxy classes and request/response models, together with shared HTTP and authentication helpers.

The package is available from our public Link3Public NuGet feed.

The proxy library covers:

  • Inbox and Outbox, including the legacy interfaces and v3.

  • Document lookups.

  • Configuration lookups.

  • Conversion-table lookups.

  • Tracking and Async Tracking.

Choose a package version compatible with your .NET application and the Link API version available in your environment. Available proxy methods and server operations can differ between versions; check the operations your integration needs. The library uses the same authentication, permissions, and processing behavior as the underlying APIs. See API Authentication for authentication setup.

Other interfaces

These interfaces already have dedicated documentation:

AS2 and AS4 use their protocol-specific security and partner configuration; the REST authentication examples are not their protocol contract.