Pular para o conteúdo principal
Recursos para IAAbra o contexto completo da documentação em Markdown para ChatGPT, Claude, Cursor, Copilot e outros agentes.
Abrir contexto completo para LLMs

Usando Postman

O que é o Postman​

O Postman é uma ferramenta para testar APIs sem precisar escrever código logo no início da integração. Com ele, você pode:

  • enviar requisições HTTP
  • configurar headers, autenticação e payloads
  • visualizar respostas da API
  • organizar chamadas em coleções

Ele é uma boa opção para validar sua autenticação, testar endpoints e entender o comportamento da ACBr API antes de implementar isso no seu sistema.

Onde fazer o download​

Você pode baixar o Postman no site oficial:

https://www.postman.com/downloads/

Se preferir, também é possível usar a versão web do Postman, mas a aplicação desktop costuma ser a opção mais prática para testes de API no dia a dia.

Como importar a collection da ACBr API​

Como a ACBr API disponibiliza sua definição OpenAPI, você pode importá-la diretamente no Postman para gerar a collection automaticamente.

Use esta URL:

https://prod.acbr.api.br/openapi/swagger.json

Passo a passo:

  1. Abra o Postman.
  2. Clique em Import.
  3. Escolha a opção para importar por Link.
  4. Cole a URL da OpenAPI da ACBr API.
  5. Confirme a importação.

Após isso, o Postman irá criar uma collection com os endpoints disponíveis.

Como usar o Postman com a ACBr API​

O fluxo mais comum é este:

  1. Obter o token de acesso.
  2. Copiar o access_token retornado.
  3. Fazer chamadas para os endpoints da API usando Authorization: Bearer <token>.

1. Criando a requisição para obter o token​

Crie uma requisição POST para:

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

Configure:

  • Método: POST
  • Header Content-Type: application/x-www-form-urlencoded
  • Body do tipo x-www-form-urlencoded

Campos do body:

  • grant_type: client_credentials
  • client_id: seu Client ID
  • client_secret: seu Client Secret
  • scope: os escopos desejados, como cep cnpj nfse

2. Enviando a requisição​

Ao enviar a requisição, a API retornará um JSON com o access_token.

Exemplo:

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJraWQiOiIw...",
  "token_type": "bearer",
  "scope": "cep cnpj nfse",
  "expires_in": 2592000
}

3. Usando o token nas demais chamadas​

Depois disso, crie ou abra uma requisição da collection importada e envie o header:

Authorization: Bearer <access_token>

Exemplo de chamada:

GET https://prod.acbr.api.br/cep/01311200
Authorization: Bearer <access_token>

Dicas práticas​

  • Use https://hom.acbr.api.br quando estiver testando no ambiente de homologação.
  • Use https://prod.acbr.api.br quando estiver operando em produção.
  • Salve o token em uma variável do Postman para reutilizar nas requisições.
  • Se a API retornar 402, verifique seus créditos e cotas em console.acbr.api.br.
  • Se a API retornar 429, reduza a frequência das chamadas e respeite os headers de retry.

Próximos passos​