Autenticação
Autenticação
Toda request para a API da FourA requer autenticação. Esta página explica como obter, usar e gerenciar a sua chave de API.
Obtendo a sua chave de API
- Faça login no FourA Dashboard
- Vá para a página API Keys
- Clique em Create Key
- Copie a chave do diálogo de confirmação
Sua chave de API se parece com isto: pk_live_a1b2c3d4e5f6...
As chaves criadas hoje são reveláveis: clique no ícone de olho na linha da chave mais tarde para trazer o segredo completo de volta sob demanda (veja Gerenciando Chaves de API para o fluxo de revelação e permissões). Chaves legadas criadas antes da revelação ser lançada não podem ser recuperadas e mostram um ícone de cadeado; regenere-as uma vez para fazer a transição.
Usando a sua chave de API
Inclua a sua chave de API no header X-API-Key de cada request:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
Em Python:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
Em Node.js:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
Segurança da chave de API
Trate a sua chave de API como uma senha:
- Não faça commit dela no controle de versão. Use variáveis de ambiente em vez disso.
- Não a exponha em código do lado do cliente. Use-a apenas em aplicações do lado do servidor.
- Faça a rotação se for comprometida. Regenere a chave a partir do Dashboard. O segredo antigo para de funcionar imediatamente, e toda revelação é registrada em log de auditoria, para que uma credencial roubada seja fácil de identificar após o fato.
Usando variáveis de ambiente
Armazene a sua chave em uma variável de ambiente:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Em seguida, referencie-a no seu código:
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
Erros comuns de autenticação
Todas as falhas de autenticação retornam um status 401 Unauthorized.
| Erro | Mensagem | Causa | Correção |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | Sem header X-API-Key na request |
Adicione o header X-API-Key |
| 401 | Invalid API key | Chave incorreta, espaço em branco extra, ou chave desativada | Verifique a chave, remova espaços em branco, ou crie uma nova chave a partir do Dashboard |
Toda response, de sucesso ou falha, carrega um header X-Foura-Request-Id. Registre-o em log do seu lado para que o suporte possa consultar uma chamada específica mais tarde.
Próximos passos
- Início rápido: Faça a sua primeira request
- Gerenciando Chaves de API: Revele, edite, regenere e exclua chaves
- Endpoints da API: Referência completa de endpoints
- Tratamento de erros: Trate erros de autenticação de forma elegante