Managing Your API Keys

An API key identifies you to the Ezana API and decides which datasets you can reach. Keys are issued manually after your access request is approved. Generating, rotating, and revoking your own keys from Settings is not currently available: the Settings API tab shows a preview layout with a sample key.

Step-by-step

1. Request access from the Ezana API page using the Request API access form.
2. When your request is approved, the team sends you a key scoped to your tier and datasets.
3. Store the key in a secret manager or server environment variable. Never paste it into client-side code, browser apps, or a public repository.
4. Send it on every request as a bearer token in the Authorization header over HTTPS.
5. If you need a new key or want an old one revoked, email api@ezana.world.

What you’ll see in Settings

Settings, then API shows a masked key with Show and Copy buttons, a monthly usage bar, a short endpoint usage table, and a Webhook URL field. These are sample values that preview the planned layout. The key shown there will not authenticate against the API, and the usage numbers are not your real usage.

Keeping a key safe

• Treat the key like a password. Anyone who has it can spend your quota.
• Keep it on the server side. Never embed it in a mobile app or web page.
• Use a separate key per environment if you are issued more than one, so a leak in testing does not affect production.
• The API page describes keys as scoped, hashed at rest, and rotatable. Rotation is handled by the team on request until self-serve tools launch.

Troubleshooting

• The Settings key does not work. That is expected. It is a placeholder, not an issued key.
• 401 Unauthorized. Check the header is exactly Authorization: Bearer followed by your key, and that the key has not been revoked.
• 429 Too Many Requests. You hit your tier’s rate limit. Cache responses and slow your request rate.
• Suspect a leak? Email api@ezana.world right away so the key can be revoked and replaced.

Next in API & Technical: Ezana Partner API Overview and Setting Up Webhooks.

Related articles

• Ezana Partner API Overview
• API Endpoints Reference
• Partner Troubleshooting Guide

FAQ

Q: Can I regenerate my key myself?

A: Not yet. Self-serve key management is not currently available. Email api@ezana.world to rotate or revoke a key.

Q: Is my key secret?

A: Yes. Treat it like a password and never expose it in public code or client apps.

Q: Why does Settings show a usage bar?

A: It previews the planned usage view. The numbers are samples, not your account’s usage.