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

  1. Log in to your Tai instance
  2. Navigate to Settings → Integrations → API Keys
  3. Click Generate New Key
  4. Give your key a descriptive name (e.g., prod-erp-integration) so you can identify it later
  5. Copy the key immediately — it will only be displayed once
⚠️

Important: Store your API key somewhere safe, such as a secrets manager or environment variable. Never commit it to source control or expose it in client-side code.

Using your API key

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Example request:

curl -X GET https://api.taicloud.net/v1/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Managing your API keys

  • You can generate multiple keys for different environments (development, staging, production)
  • Keys can be revoked at any time from Settings → Integrations → API Keys
  • 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


Updated 18 days ago