Autenticação

Todas as requisições para a FourA API exigem autenticação. Esta página explica como obter, usar e gerenciar sua chave de API.

Como obter sua chave de API

1. Faça login no FourA Dashboard
2. Acesse a página API Keys
3. Clique em Create Key
4. Copie a chave na caixa de diálogo de confirmação

Sua chave de API tem a seguinte aparência: pk_live_a1b2c3d4e5f6...

As chaves criadas hoje podem ser reveladas: clique no ícone de olho na linha da chave para visualizar o secret completo sob demanda (consulte Gerenciamento de chaves de API para o fluxo de revelação e permissões). As chaves legadas criadas antes do lançamento deste recurso não podem ser recuperadas e exibem um ícone de cadeado; gere-as novamente para migrar.

Como usar sua chave de API

Inclua sua chave de API no header X-API-Key de cada requisição:

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"}
)

No 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 API Key

Trate sua API key como uma senha:

• Não faça commit dela no controle de versão. Em vez disso, use variáveis de ambiente.
• Não a exponha no código client-side. Use-a apenas em aplicações server-side.
• Faça a rotação se comprometida. Gere novamente a chave no Dashboard. O segredo antigo para de funcionar em um minuto, e cada visualização é registrada em log de auditoria, facilitando a identificação posterior de uma credencial roubada.

Como Usar Variáveis de Ambiente

Armazene sua chave em uma variável de ambiente:

export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."

Em seguida, faça referência a isso 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.

Toda response, seja de sucesso ou falha, contém um header X-Foura-Request-Id, exceto em casos onde o FourA não consegue ler o body (JSON malformatado ou body com mais de 100 KB), que é recusado antes da atribuição de um ID. Registre esse valor nos seus logs para que o suporte possa consultar uma chamada específica posteriormente.

Próximos passos

• Início Rápido: Faça sua primeira request
• Gerenciamento de Chaves de API: Visualize, edite, gere novamente e exclua chaves
• Endpoints da API: Referência completa de endpoints
• Tratamento de Erros: Trate erros de autenticação de forma adequada