Authentication

The Yuzu API uses the X-API-Key header for authentication.

Create an API key

1. Open Settings > API Keys.
2. Click Create API Key.
3. Give the key a clear name, such as warehouse-sync-production.
4. Copy the secret before closing the confirmation screen.

Yuzu only shows the full key once. If the secret is lost, revoke it and create a new key.

Send the key

Include the key with every API request:

X-API-Key: YOUR_API_KEY

curl 'https://app.yuzu.so/api/orders' \
  --header 'X-API-Key: YOUR_API_KEY'

Handling keys

Store API keys in your server-side secret manager. Do not expose them in browser code, mobile apps, public repos, logs, or support screenshots.

Use separate keys for development and production so you can rotate one environment without breaking the other.

Common auth errors