Comece aqui
Autenticação
Os endpoints de envio usam uma chave de aplicação como Bearer token. A chave identifica a aplicação, a conta e o modo de execução.
Nesta página
Cabeçalho da requisição
Authorization: Bearer ak_test_SUA_CHAVECrie a aplicação no painel e salve a chave em uma variável de ambiente. Envie o cabeçalho em todas as chamadas a /v1/send, status e verificação.
Use HTTPS. Não registre o cabeçalho de autenticação em logs nem inclua a chave em URLs.
Chaves de teste e de produção
| Chave | Modo | Efeito |
|---|---|---|
ak_test_… | test | Cria envios gratuitos e simula a entrega. |
ak_live_… | live | Cria envios reais e reserva uma unidade da cota ou um crédito. |
Use credenciais próprias para cada aplicação e ambiente. A idempotência pertence à aplicação; consultar e verificar um envio usa o escopo da conta autenticada.
Proteja a integração
- Faça as chamadas à aut2fa no seu servidor.
- Vincule o ID do envio à sessão e à pessoa que pediu a autenticação.
- Valide a sessão antes de aceitar pedidos de envio, reenvio ou verificação.
- Se uma chave vazar, revogue-a no painel, crie outra e atualize a configuração do servidor.
Não aceite um ID arbitrário vindo do navegador como prova de que um envio pertence à sessão atual.
Falhas de autenticação
| HTTP | Código | Próxima ação |
|---|---|---|
| 401 | missing_credentials | Envie Authorization com Bearer e a chave. |
| 401 | invalid_api_key | Confira a credencial, sua configuração e se foi revogada. |
GET /v1/signup-settings é público e não exige esse cabeçalho. Ele informa a cota vigente para novos cadastros; veja cota de cadastro.