Autenticação

Toda requisição para a FourA API exige 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 janela de confirmação

Sua chave de API tem o seguinte formato: pk_live_a1b2c3d4e5f6...

Chaves criadas recentemente podem ser reveladas: clique no ícone de olho na linha da chave para visualizar o secret completo novamente quando precisar (consulte Gerenciando chaves de API para o fluxo de visualização e permissões). Chaves antigas criadas antes desse recurso não podem ser exibidas novamente e mostram um ícone de cadeado; gere uma nova chave para atualizar.

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. Use variáveis de ambiente em vez disso.
  • Não exponha a chave em código client-side. Use-a apenas em aplicações server-side.
  • Faça a rotação se for comprometida. Gere novamente a chave pelo Dashboard. O segredo antigo para de funcionar em um minuto, e cada visualização é registrada em log de auditoria para facilitar a identificação de credenciais roubadas.

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 o status 401 Unauthorized.

Erro Mensagem Causa Correção
401 Missing API key. Include X-API-Key header. Nenhum header X-API-Key na request Adicione o header X-API-Key
401 Invalid API key Chave incorreta, espaços em branco extras ou chave desativada Verifique a chave, remova espaços em branco ou crie uma nova chave no Dashboard

Se a FourA não conseguir validar uma chave momentaneamente, por exemplo durante uma transição de banco de dados, ela responderá com 503, API key check temporarily unavailable e Retry-After: 5, nunca 401. Tente novamente após essa espera: sua chave é válida.

Toda response, de sucesso ou falha, contém um header X-Foura-Request-Id, exceto quando o corpo não pode ser lido de forma alguma pela FourA (JSON malformado ou corpo acima de 100 KB), sendo recusado antes da atribuição de um ID. Registre isso em seus logs para que o suporte possa localizar uma chamada específica depois.

Próximos Passos

Atualizado em: 29 de outubro de 2026