Guides

Obtaining an API Key

Page 2: Obtaining an API Key)

All requests to the Tai API require authentication via an API key. This guide walks you through generating your key and using it securely.

Prerequisites

  • You must have an active Tai account
  • Your account must have API access enabled — contact your Tai account manager if you're unsure

Generating your API key

API keys in Tai are issued to a staff member — the key inherits that staff's permissions and is identified in the list by their name. There is no separate name/label field, so most teams create a dedicated integration staff user (e.g. ERP Integration) rather than attaching the key to a real person's account.

  1. Log in to your Tai instance
  2. Navigate to Back Office → LSP → Public Authentication Keys
  3. Click Add Key
  4. Select the staff member the key will run as. For a customer-facing key, also select the Organization it should be scoped to
  5. Save, then copy the key immediately — it will only be displayed once

Using your API key

All requests to the TAI public API must include your key in the x-api-key request header.

x-api-key: <your_api_key>

Example

curl -X GET "https://api.taicloud.net/publicapi/v2/shipments/12345" \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY_HERE"

Managing your API keys

  • You can generate multiple keys for different environments (development, staging, production)
  • Keys can be revoked at any time from Back Office → LSP → Public Authentication Keys by setting their status to inactive
  • Rotating keys periodically is strongly recommended as a security best practice
  • If a key is compromised, revoke it immediately and generate a new one

Permissions and scopes

API keys inherit the permissions of the Tai user account under which they were created. Ensure the account used to generate the key has the appropriate access level for your integration's needs.

Next steps