Autenticação

Chaves de API e Bearer Token

Todas as requisições à API da Faroway são autenticadas via Bearer Token no header Authorization.

Obtendo sua chave de API#

1Crie uma conta em faroway.tech/sign-up
2Acesse o painel e navegue até Configurações → Chaves de API
3Gere uma chave para o ambiente desejado: dev ou prod

Segurança

Sua chave de API é exibida uma única vez no momento da criação. Armazene-a em um local seguro (variáveis de ambiente, vault, etc). Nunca exponha a chave no frontend ou em repositórios públicos.

Enviando o token#

Inclua o header Authorization com o valor Bearer sua_chave_de_api em todas as requisições.

Exemplo de header

http

Authorization: Bearer fwy_prod_a1b2c3d4e5f6...

cURL

bash

curl -X POST https://api.faroway.tech/v1/score \
  -H "Authorization: Bearer fwy_prod_a1b2c3d4e5f6..." \
  -H "Content-Type: application/json" \
  -d '{"document": "123.456.789-09", "document_type": "cpf"}'

Ambientes dev e prod#

Cada chave de API está vinculada a um ambiente específico. Dados, webhooks e consultas são completamente isolados entre ambientes.

Ambiente	Prefixo da chave	Uso
dev	`fwy_dev_`	Testes e desenvolvimento. Dados simulados.
prod	`fwy_prod_`	Produção. Consultas reais e cobranças ativas.

Dica

Comece sempre pelo ambiente dev. Ele funciona com dados simulados e permite testar toda a integração sem consumir créditos de produção.

Erros de autenticação#

Se a chave for inválida, ausente ou expirada, a API retorna 401 Unauthorized:

Resposta — 401

json

{
  "error": "Invalid or missing API key."
}

Veja todos os códigos de status possíveis na página de códigos de resposta.