Status da API

Não existe página de status pública

Hoje a Faturei Hoje não publica painel de disponibilidade, histórico de incidente nem endereço que responda “no ar” ou “fora do ar”. Quando isso mudar, o aviso vem aqui.

Esta página é o que dá para fazer enquanto isso, e ela responde a pergunta que importa na hora: o problema é meu ou é de vocês?

A chamada que serve de teste

GET /public/v1/me responde a qualquer chave válida e não exige permissão nenhuma. É a chamada mais barata para saber se a API está respondendo e se a sua chave está boa.

• 200: a API está no ar e a sua chave vale. O problema está na outra chamada, não na API.
• Qualquer outra coisa: use a lista abaixo.

O comando está em Primeiros passos, nos quatro idiomas de código.

Não procure um endereço de verificação de saúde: no host da API só respondem /public/v1 e o security.txt. Todo o resto responde 404.

De quem é o problema

A resposta já diz de que lado está o conserto. O que manda é o code, não o texto.

É do seu lado

• 401 api_key_invalid. Cabeçalho, chave, estado da chave e lista de IPs. O roteiro completo está em Autenticação.
• 403 permission_missing, member_permission_denied, access_denied. Permissão da chave e papel do membro. Veja Permissões.
• 403 subscription_inactive, plan_feature_unavailable, plan_limit_reached, organization_suspended. Assinatura, plano ou estado da empresa. Conserto no painel.
• 404 route_not_found. Caminho ou host errado.
• 422 validation_failed. O corpo traz errors, campo a campo.
• 429 rate_limit_exceeded. Espere o tempo do Retry-After antes de repetir. Veja Limites de uso.

É do nosso lado

• 500 internal_error. Guarde o request_id e escreva.
• 503 service_unavailable. Tente de novo em instantes. Se persistir, escreva.

É a rede no meio

• Sem resposta, tempo esgotado, erro de TLS. A chamada não chegou até nós, ou a resposta não chegou até você. Teste de outra rede antes de escrever.

O 429 também aparece quando um mesmo endereço acumula falhas de autenticação, mesmo com chave certa. Nesse caso o conserto é parar de repetir a chamada errada, e não esperar a API voltar.

Como saber se é geral ou só com você

• Repita de outra rede. Outro servidor, o seu computador, o celular fora do Wi-Fi da empresa. Se funciona de um lugar e não de outro, o problema está no caminho, não na API. Se a chave tem lista de IPs, a chamada de outra rede vai receber 401 e isso é esperado: teste com uma chave sem lista, ou tire conclusão só dos erros 500 e 503.
• Repita depois de um minuto. 429 e 503 são temporários por natureza.
• Olhe Ver uso no painel. Se a chamada nem aparece ali, ela não chegou a ser reconhecida como sua, e o problema está no cabeçalho, no token ou no host.
• Conte. Várias chamadas seguidas com 500 ou 503, de mais de uma rede, é problema nosso. Uma chamada isolada com 500 no meio de centenas que funcionam também vale um e-mail, com o request_id.

O que não prometemos aqui

Não publicamos métrica de disponibilidade, não anunciamos janela de manutenção e não prometemos aviso de indisponibilidade. Escrever qualquer uma dessas coisas sem o processo por trás seria enfeite, e enfeite em página de status é pior do que nada.

O que a documentação garante sobre mudança de contrato é outra coisa, e essa tem trava automática: veja Versões e changelog.

Quando escrever

Junte o request_id, o horário com o fuso, o método, o caminho, o status e o code, e mande para dev@fatureihoje.com. A lista completa está em Contato.

Próximo passo

• Contato: o que ter em mãos antes de escrever.
• Limites de uso: os cabeçalhos que dizem quanto sobrou do seu orçamento.
• Erros: o que cada code quer dizer.