Documentação da API

A API pública do Faturei Hoje é o caminho para outro sistema falar com a sua empresa no Faturei Hoje sem passar pelo painel: chamadas HTTP, autenticadas por uma chave que você cria e revoga quando quiser.

Esta documentação está sendo escrita. A Referência já mostra, campo a campo, o que a v1 publica hoje.

Endereço

Toda chamada da v1 vai para este endereço:

https://api.fatureihoje.com/public/v1

Autenticação

A chave é criada no painel, em Configurações, e viaja no cabeçalho Authorization:

Authorization: Bearer fh_live_sua_chave

Cada chave carrega só as permissões escolhidas na hora de criá-la. Guarde a chave no seu servidor: ela não deve aparecer no navegador nem dentro de um aplicativo instalado no celular do seu cliente.

O cabeçalho Accept-Language escolhe o idioma das mensagens de erro. O código do erro, os nomes dos campos e as rotas são iguais em qualquer idioma.

Primeira chamada

GET /me responde de quem é a chave: a empresa, as permissões concedidas e os limites de uso. É a chamada certa para confirmar que a chave está válida antes de escrever qualquer integração.

curl https://api.fatureihoje.com/public/v1/me \
  -H "Authorization: Bearer fh_live_sua_chave" \
  -H "Accept-Language: pt-BR"

A Referência lista as rotas publicadas, com os campos de cada resposta e os erros que cada uma pode devolver.