Teste a API com o Postman

Use a coleção oficial do Asaas para testar os endpoints em Sandbox antes de implementar as requisições na sua aplicação.

Quando utilizar

Use a coleção para:

• explorar os endpoints da API;
• validar autenticação, headers e URLs;
• testar requisições antes de escrever código;
• reproduzir erros durante o desenvolvimento;
• compartilhar requisições com seu time.

Antes de começar

Você precisa:

1. Instalar o Postman ou acessar a versão web.
2. Criar uma conta no Sandbox do Asaas.
3. Gerar uma chave de API para o Sandbox.
4. Consultar os requisitos de autenticação.

1. Faça uma cópia da coleção

1. Acesse a coleção oficial:

Acessar Asaas API no Postman

2. No menu lateral, expanda Asaas API e selecione Collection Asaas.

3. Clique em Fork, no canto superior direito, e escolha o Workspace em que deseja salvar a coleção.

2. Configure o ambiente

Use a URL correspondente ao ambiente da sua chave de API:

Configure também os headers:

Caso a coleção utilize variáveis, atualize a URL base e a chave de API antes de enviar a primeira requisição.

Se os valores estiverem configurados diretamente na requisição, revise a URL e os headers individualmente.

3. Teste uma requisição

1. Selecione um endpoint na Collection Asaas.
2. Confirme a URL do ambiente.
3. Verifique os headers da requisição.
4. Preencha os parâmetros ou o body, quando necessário.
5. Clique em Send.
6. Confira o status HTTP e o corpo da resposta.

Uma operação realizada com sucesso deve retornar um status 2xx. O código específico depende do endpoint utilizado.

Como confirmar a autenticação

Caso a chave pertença a outro ambiente, a API poderá retornar:

{
  "errors": [
    {
      "code": "invalid_environment",
      "description": "A chave de API informada não pertence a este ambiente"
    }
  ]
}

Caso o header access_token não seja enviado:

{
  "errors": [
    {
      "code": "access_token_not_found",
      "description": "O cabeçalho de autenticação 'access_token' é obrigatório e não foi encontrado na requisição"
    }
  ]
}

Erros comuns

Próximos passos

• Conheça o Sandbox
• Consulte a autenticação da API
• Aprenda a gerenciar suas chaves de API
• Acesse a referência da API