Chaves API
Uma chave para cada tarefa, e nada mais.
Dê a cada serviço a sua própria chave, só com as permissões e remetentes de que precisa. Cada chamada que faz fica registada.
Em resumo
O que é uma chave API?
Um segredo que o seu código envia com cada pedido. Diz para que espaço de trabalho é a chamada e o que pode fazer.
32
permissões à escolha
25
domínios inteiros num âmbito de envio
3,650
dias, a validade mais longa
Como funciona
Uma função como teto
Associe uma função e a chave nunca pode fazer mais do que ela permite. GET /ping mostra o que a chave indica e o que a função lhe deixa.
Limite em nome de quem envia
Até 25 domínios inteiros e 50 endereços soltos. Um remetente fora deles recebe um 403.
Cada chamada registada
Método, caminho, estado, erro e duração de cada pedido, com as rotas mais usadas e quantas vezes falham.
Verifique o que uma chave pode fazer
GET /ping não precisa de permissões e responde com o alcance da chave.
{ "ok": true, "keyId": "4c1b257a66287fd113bd89d0", "mode": "live", "scopes": ["emails:send", "templates:write", "members:write"], "roleId": "role_2b81de079c1f0a4b7e05d386", "grantedScopes": ["emails:send", "templates:write"], "workspaceId": "10417196-e324-4283-af98-66ec62167c47"}O que recebe
Já no produto
Rodar sem mudar a chave
Um segredo novo, com o mesmo id, permissões e histórico.
Revogada, não apagada
Uma chamada posterior recebe revoked_api_key.
Validade incluída
Faça uma chave caducar, até dez anos à frente.
Boas práticas
Tirar o máximo partido
- 01
Uma chave por serviço
Assim uma fuga custa uma integração, não todas.
- 02
Conceda o mínimo
Comece por emails:send e acrescente permissões quando uma chamada precisar.
- 03
Vigie as falhas
Filtre o registo de pedidos pelas chamadas falhadas depois de uma implementação.
Ponto de situação
Convém saber
- Sem lista de IP permitidos
- Ainda não é possível prender uma chave aos endereços dos seus servidores.
- Sem chaves de teste
- Só se podem criar chaves oe_live_, por isso cada envio é real.
- Sem registo pela API
- O registo de pedidos consulta-se na app, não numa rota REST.
Perguntas
O que mais nos perguntam
Continue a explorar
Combina bem com
Começar
O seu domínio,
o seu correio.
Aponte um domínio para o OpenEmail e leia o correio dele numa caixa de correio construída à volta dele. O plano gratuito inclui um domínio.
