Autenticação e chaves de API

A API REST do AeroReply vive em https://api.aeroreply.com/public/v1. Todos os pedidos são autenticados com uma chave de API que pertence a um workspace.

Criar uma chave

Âmbitos

Enviar a chave

Use o cabeçalho Authorization. Um cabeçalho x-api-key também é aceite, para ferramentas que não conseguem definir um token Bearer.

curl https://api.aeroreply.com/public/v1/me \
  -H "Authorization: Bearer ar_live_…"

GET /me não precisa de nenhum âmbito, por isso é a forma mais rápida de verificar uma chave. Devolve o workspace e os âmbitos da chave.

{
  "workspace": {
    "id": "cml0ws789",
    "name": "Acme Studio"
  },
  "scopes": [
    "read",
    "write"
  ]
}

Gerir chaves

• Desativar uma chave com o respetivo interruptor. Os pedidos falham até a voltar a ativar.
• Rodar segredo emite um novo segredo. O antigo deixa de funcionar de imediato.
• Revogar permanentemente elimina o acesso para sempre. Isto não pode ser desfeito.

Apenas o Owner, ou uma função personalizada com Gerir membros, pode criar ou alterar chaves. Os pedidos são executados com as permissões da pessoa que criou a chave.