Getting Started

Getting Started

Welcome to the Audicient API documentation. This guide will help you understand how to interact with our API and integrate it into your systems.

Environments

Audicient provides separate environments for staging and production. Please note that the staging environment does not allow user access. To test the platform, contact our support team at [e-mail] to request access to the production environment.

Staging Environment (Restricted Access)

• API: https://staging-api.audicient.com

• Web Interface: https://staging.audicient.com

Production Environment

• API: https://api.audicient.com

• Web Interface: https://your-name.client.audicient.com

Authentication

Our API requires authentication using an API key and API secret, which are provided by the Audicient account manager. These credentials should be passed in the Authorization header using Basic Authentication.

Important: The API key and API secret must never appear on the client side, as this could allow users to exploit the API.

Example:

GET /some-endpoint
Host: api.audicient.com
Authorization: <API_KEY>:<API_SECRET>

Tenant and User Model

Audicient operates on a tenant-based model:

• Tenant Admins: Do not need to pass a workspace ID.

• User Accounts: Must pass enterprise-id in the request headers.

Example request for user operations:

GET /some-endpoint
Host: api.audicient.com
Authorization: <API_KEY>:<API_SECRET>
enterprise-id: 123456

Now that you're set up, continue exploring our API endpoints in the following sections.