Skip to main content

API Keys

API keys authenticate your applications with the MAES Platform API.

Using API Keys​

Include your API key in the Authorization header:

curl -X GET "https://api.maes-platform.nuvoni.eu/v1/projects/{projectId}/cards" \
-H "Authorization: Bearer sk_sandbox_xxxxx"

Key Format​

sk_{environment}_{random_string}
ComponentExample
Prefixsk_
Environmentsandbox_ or live_
Random stringaBcDeFgHiJkLmNoPqRsTuVwXyZ123456789

Key Types​

TypePrefixAccess
Sandboxsk_sandbox_*Sandbox environment
Productionsk_live_*Production environment

Error Responses​

Missing Header​

Status: 401 Unauthorized

{
"code": "error.unauthorized",
"message": "Missing Authorization header"
}

Invalid Format​

Status: 401 Unauthorized

{
"code": "error.unauthorized",
"message": "Invalid Authorization header format. Use: Bearer YOUR_API_KEY"
}

Invalid Key​

Status: 401 Unauthorized

{
"code": "error.unauthorized",
"message": "Invalid or expired API key"
}

Wrong Project​

Status: 403 Forbidden

{
"code": "error.forbidden",
"message": "API key does not have access to this project"
}

Revoked Key​

Status: 401 Unauthorized

{
"code": "error.unauthorized",
"message": "API key has been revoked"
}