Prerequisites & Setup

Before integrating with the Platform API, make sure you have the following in place.

Account and credentials

You'll need a Platform account with API access enabled. Once your account is provisioned:

Log in to the Platform web app
Navigate to Settings → API Credentials
Copy your Client ID and generate a Client Secret

Keep your Client Secret safe

Your Client Secret is shown only once. Store it securely — you'll need to generate a new one if it's lost.

Supported environments

Environment	Base URL
Production	`https://api.example.com`
Staging	`https://staging-api.example.com`

The Identity (token) server is at https://identity.example.com for all environments.

Network requirements

Ensure your environment can reach:

https://identity.example.com — for token requests
https://api.example.com — for Upload and GetResults calls
https://kafka.example.com:9092 — for the AsyncAPI event stream (if applicable)

Authentication overview

The Platform uses OAuth 2.0 Client Credentials for all API access. You exchange your Client ID and Secret for a short-lived bearer token, then include that token in the Authorization header of every request.

See Getting started for a quick walkthrough, or the bearer token tutorial (C#) for a full code example.

SDK and example code

Official example projects are available for download:

C#.NET example project with helper library

Third-party SDKs and OpenAPI-generated clients are also supported — import the Synchronous API spec into your tool of choice.