Voltar
Fortbix
Documentação da API

Primeiros Passos

Configure sua integração com a API Fortbix em minutos.

Autenticação

Toda requisição à API Fortbix pública deve incluir uma chave (api-key) no header:

api-key: fb_<env>_<sua-chave>

A autenticação usa apenas o header api-key, em todos os métodos (GET, POST, PUT, PATCH, DELETE). Não é necessário enviar timestamp nem signature.

Obtendo uma chave

  1. Acesse o portal de administração da Fortbix.
  2. Vá em API Keys.
  3. Clique em Gerar nova chave.
  4. Copie o valor exibido apenas uma vez e guarde em local seguro.

Ambientes

A API Fortbix está disponível em dois ambientes públicos:

Sandbox

https://hml-sandbox.api.fortbix.com

Ambiente para testes e desenvolvimento. Dados isolados.

Produção

https://hml-api.fortbix.com

Ambiente real. Use as chaves emitidas com prefixo fb_prod_….

Primeira Requisição

Faça uma chamada de leitura para validar a credencial:

curl -X GET https://hml-sandbox.api.fortbix.com/global-account/api/v1/customers \
  -H "api-key: fb_sandbox_<sua-chave>"

Rate Limiting

As respostas incluem headers com informações de limite de taxa:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1234567890