Skip to content

API documentation

The Faturei Hoje public API is how another system talks to your company in Faturei Hoje without going through the panel: HTTP calls, authenticated with a key that you create and revoke whenever you want.

This documentation is being written. The Reference already shows, field by field, what v1 publishes today.

Every v1 call goes to this address:

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

You create the key in the panel, under Settings, and send it in the Authorization header:

Authorization: Bearer fh_live_your_key

Each key carries only the permissions you granted when you created it. Keep the key on your server: it should never show up in a browser or inside an app installed on your customer’s phone.

The Accept-Language header picks the language of the error messages. Error codes, field names and routes are the same in every language.

GET /me answers who the key belongs to: the organization, the permissions granted and the usage limits. It is the right call to confirm the key works before writing any integration.

Terminal window
curl https://api.fatureihoje.com/public/v1/me \
-H "Authorization: Bearer fh_live_your_key" \
-H "Accept-Language: en"

The Reference lists the published routes, with the fields of each response and the errors each one can return.