Primeiros passos

Se você quer só o essencial para começar a integrar com a ACBr API, use esta página como referência rápida.

URLs base

Use a URL conforme o ambiente da sua credencial:

Credenciais do tipo Produção | Sandbox

URL base da API de produção

https://prod.acbr.api.br

Aceita documentos com finalidade produção e homologação.

URL base da API de homologação

https://hom.acbr.api.br

Aceita documentos com finalidade homologação.

URL de autenticação OAuth 2

https://auth.acbr.api.br/realms/ACBrAPI/protocol/openid-connect/token

info

As credenciais do tipo Produção e Sandbox utilizam o mesmo endpoint de autenticação. O que muda é a URL base da API usada depois de obter o token.

Como a autenticação funciona

Toda requisição para a ACBr API deve enviar o header HTTP Authorization no formato abaixo:

Authorization: Bearer <access_token>

Esse access_token é obtido via OAuth 2 usando o fluxo client_credentials.

Payload para obter o token

Faça uma requisição POST para a URL de autenticação com:

• Header Content-Type: application/x-www-form-urlencoded
• Corpo com os campos grant_type, client_id, client_secret e scope

Exemplo:

POST https://auth.acbr.api.br/realms/ACBrAPI/protocol/openid-connect/token HTTP/1.1
Host: auth.acbr.api.br
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=abcdef&client_secret=123456&scope=cep%20cnpj%20nfse

Campos do payload:

• grant_type: sempre client_credentials
• client_id: seu Client ID
• client_secret: seu Client Secret
• scope: escopos que o token deve possuir, separados por espaço, como cep cnpj nfse

Exemplo completo

Primeiro obtenha o token:

curl --request POST "https://auth.acbr.api.br/realms/ACBrAPI/protocol/openid-connect/token" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "client_id=SEU_CLIENT_ID" \
  --data-urlencode "client_secret=SEU_CLIENT_SECRET" \
  --data-urlencode "scope=cep cnpj nfse"

Depois use o token nas chamadas da API:

GET https://prod.acbr.api.br/cep/01311200 HTTP/1.1
Host: prod.acbr.api.br
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiOiIw...
Accept: */*

Testando com Postman

Se você prefere validar a integração antes de escrever código, recomendamos usar o Postman.

Nele você pode:

• importar a definição da ACBr API
• gerar uma collection automaticamente
• configurar a autenticação
• testar os endpoints visualmente

Consulte o guia completo em Usando Postman.

Próximos passos

• Para aprender a testar a API com interface gráfica, consulte Usando Postman
• Para criar credenciais no console e ver o fluxo completo de autenticação, consulte Autenticação
• Para ver todos os endpoints disponíveis, consulte a referência da API