APIs dos sistemas Brotas System

Todos os sistemas seguem o mesmo padrão: chave de API no cabeçalho, JSON nas duas direções, erros no mesmo formato e webhooks assinados. Aprendeu a integrar com um, já sabe integrar com os outros.

Primeiros passos

Como começar

A chave é emitida pelo administrador da sua conta, dentro do painel do sistema. Ela vale só para a sua empresa e só para o que os escopos permitirem.

1Gere a chave

No painel do sistema, em Integrações, crie uma chave com os escopos necessários. O segredo aparece uma vez só.

2Teste a conexão

Chame GET /api/v1/me com Authorization: Bearer e confira a empresa e os escopos da chave.

3Integre

Use a referência do sistema para listar, criar e atualizar registros, e cadastre webhooks para receber eventos.

curl https://<endereço do sistema>/api/v1/me \
  -H "Authorization: Bearer bsk_unifiscal_live_8Hq2...9xT1"
Referência

APIs por sistema

Os sistemas entram aqui conforme a API padronizada é publicada. Quem ainda está em implantação mostra a situação atual.

Padrão

O que vale para todas as APIs

Autenticação

Chave bsk_ no cabeçalho Authorization, com escopos por recurso, validade e lista de IPs opcional. Detalhes

Erros

Formato RFC 9457 com code estável e request_id para suporte. Detalhes

Webhooks

Eventos assinados com HMAC-SHA256 e carimbo de tempo, com reenvio automático. Detalhes