Autenticação

A autenticação em nossa API é feita através do uso de uma chave de API. É através desta chave que nosso sistema identifica a sua conta e permite a comunicação conosco em nome da conta em questão.

Caso a chave de API seja inválida, não seja informada ou o header esteja incorreto, nossa API retornará HTTP 401.

📘

Ambientes distintos (Sandbox e Produção)

As chaves de API são distintas entre os ambientes de Sandbox e Produção, portanto lembre-se de alterá-la quando mudar a URL.

Para obter sua chave de API, acesse a área de configurações em nossa interface web (Menu do usuário > Configurações > Chaves de API).

🔒

Gerenciando suas chaves de API

• Você pode criar até 10 chaves de API.
• As chaves podem ser nomeadas, para facilitar a identificação.
• É possível definir uma data de expiração para cada chave.
• Você pode desabilitar/habilitar uma chave a qualquer momento, sem de fato invalidá-la.
• Caso a chave seja excluída, não é possível restaurá-la.

URL de Produção e Sandbox

Após a criação da conta e geração da chave de API, utilize a URL específica para cada ambiente em suas chamadas, conforme listado abaixo:

Teste em ambiente Sandbox

Durante o desenvolvimento da integração, teste as requisições em nosso ambiente de Sandbox utilizando dados fictícios e direcionando as requisições para o domínio “api-sandbox.baseerp.com.br", alterando para produção apenas após a validação de todas as funcionalidades.

❗️

ATENÇÃO: Para testar os endpoints direto nesta documentação você precisa de uma chave de API de Sandbox

Caso seja utilizada a chave de produção, obterá o erro 401 Unauthorized.

Todos os endpoints da documentação apontam para nosso Sandbox, o ambiente de testes do Asaas. Antes de começar você deve criar uma conta de testes e usar sua chave de API para testes.

Saiba mais sobre o Sandbox