Autenticação
O Reigniter API usa API chaves. Cada chave pertence a uma conta e funciona como essa conta: ela gasta os créditos dessa conta e vê apenas os trabalhos dessa conta.
Crie uma chave
Seção intitulada “Crie uma chave”API chaves fazem parte do plano Agency.
- Faça login para Reigniter.
- Abrir > API Conta (
/app/account/api-keys). - Em Criar nova chave, digite um rótulo que você reconhecerá depois, como
CI pipelineouCMS sync. - Selecione Criar.
- Copie a chave imediatamente.
Uma chave é assim: emp_ seguida de 64 caracteres hexadecimais.
Envie a chave
Seção intitulada “Envie a chave”Coloque a chave no cabeçalho Authorization como um token Portador em cada requisição:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"Uma chave válida retorna 200 com sua conta:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "name": "Sam", "credits_remaining": 42}Quando uma chave é recusada
Seção intitulada “Quando uma chave é recusada”| Status | code |
Significado |
|---|---|---|
401 |
NO_API_KEY |
Sem cabeçalho Authorization, ou o token não começa com emp_. |
401 |
INVALID_API_KEY |
A chave é desconhecida ou foi revogada. |
402 |
PLAN_UPGRADE_REQUIRED |
A chave é válida, mas a conta não está no plano Agency. |
403 |
ACCOUNT_SUSPENDED |
A conta que possui a chave está suspensa. |
Se uma conta sair do plano Agency, suas chaves param de funcionar até que ela volte a Agency.
Mantenha as chaves em segredo
Seção intitulada “Mantenha as chaves em segredo”- Armazene chaves em um gerenciador secreto ou variável de ambiente. Nunca as comprometa com controle de versão.
- Ligue para o API apenas do seu servidor. Nunca envie uma chave em uma página web ou aplicativo móvel. Requisições de navegador para o API não são permitidas pela política de CORS de qualquer forma.
- Use uma chave por sistema, com um rótulo claro. Assim, você pode revogar uma sem quebrar as outras.
- A tela de API teclas mostra quando cada tecla foi usada pela última vez. Uma chave que você não reconhece, ou usada quando não deveria, deve ser revogada.
Revogar uma chave
Seção intitulada “Revogar uma chave”- Abrir > API chaves da conta.
- Em Chaves Ativas, encontre a chave pelo rótulo.
- Selecione o ícone de Revogar chave (bin).
Uma chave revogada é recusada imediatamente com 401 INVALID_API_KEY. Revogar não pode ser desfeito. Renders já iniciados com a chave continuam rodando.