Autenticação

A API da AltiviaCloud autentica cada requisição por chave de API.

Chaves de API

As chaves começam com ac_live_ e podem ir na requisição de duas formas:

Token Bearer (recomendado)

HTTP

Authorization: Bearer ac_live_SUA_CHAVE

Cabeçalho X-API-Key

HTTP

X-API-Key: ac_live_SUA_CHAVE

A chave completa só é exibida no momento em que é criada: a plataforma guarda apenas o hash e os primeiros caracteres, para você identificar cada chave no painel.

Segurança

Nunca exponha a chave em código de front-end ou em repositório público.
Troque as chaves periodicamente pelo painel — dá para fazer sem derrubar a integração.
Use chaves separadas para desenvolvimento e produção.
Revogue na hora qualquer chave que tenha sido exposta.

Limites de requisição

Cada chave permite 120 requisições por minuto. Passar disso devolve 429 Too Many Requests, com o cabeçalho Retry-After dizendo quanto esperar.

Erros

Todo erro segue o mesmo formato:

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Trate o erro pelo code, não pela message: o texto pode mudar, o código não. O que fazer com cada status HTTP.