Developer Guides
API Keys
Request, rotate, and manage API keys for the Andamio Gateway
API Keys
Authenticated requests to the Andamio API require an API key in the X-API-Key header. API keys identify your application and determine your rate limits and quotas. A few public endpoints (developer registration, login, billing plans) do not require a key.
Prerequisites
Before requesting an API key:
- Register a developer account
- Verify your email address (required for key creation)
Request a Key
curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/request \
-H "X-API-Key: $EXISTING_KEY" \
-H "Authorization: Bearer $DEV_JWT" \
-H "Content-Type: application/json" \
-d '{"name": "my-app-preprod"}'The response includes the key value. Store it securely — it won't be shown again.
The number of keys you can create depends on your billing tier.
Rotate a Key
Replace an existing key with a new one. The old key is immediately invalidated:
curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/rotate \
-H "X-API-Key: $EXISTING_KEY" \
-H "Authorization: Bearer $DEV_JWT" \
-H "Content-Type: application/json" \
-d '{"key_id": "uuid-of-key-to-rotate"}'Rotation requires a verified email address.
Delete a Key
curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/delete \
-H "X-API-Key: $EXISTING_KEY" \
-H "Authorization: Bearer $DEV_JWT" \
-H "Content-Type: application/json" \
-d '{"key_id": "uuid-of-key-to-delete"}'Check Profile and Usage
View your developer profile and current quota:
# Profile and quota info
curl https://preprod.api.andamio.io/api/v2/apikey/developer/profile/get \
-H "X-API-Key: $API_KEY" \
-H "Authorization: Bearer $DEV_JWT"
# Usage statistics
curl https://preprod.api.andamio.io/api/v2/apikey/developer/usage/get \
-H "X-API-Key: $API_KEY" \
-H "Authorization: Bearer $DEV_JWT"From the CLI:
andamio apikey profile
andamio apikey usageAPI Key Endpoints
| Method | Endpoint | Auth Required | Description |
|---|---|---|---|
GET | /v2/apikey/developer/profile/get | API Key + Developer JWT | Developer profile and quota |
GET | /v2/apikey/developer/usage/get | API Key + Developer JWT | Usage statistics |
POST | /v2/apikey/developer/key/request | API Key + Developer JWT + Verified Email | Create new key |
POST | /v2/apikey/developer/key/rotate | API Key + Developer JWT + Verified Email | Rotate existing key |
POST | /v2/apikey/developer/key/delete | API Key + Developer JWT | Delete a key |
POST | /v2/apikey/developer/account/delete | API Key + Developer JWT | Delete developer account |
Next Steps
- Billing — Pricing tiers, rate limits, and quotas
- API Integration — Using your key in requests
- Developer Accounts — Registration and email verification