API
Chaves de API
Use chaves de API para autenticar requisições de API
A API Base39 utiliza chaves de API para autenticar requisições. Use a chave no header Authorization
em todas as requisições. Se uma solicitação não incluir uma chave válida, a Base39 retornará um erro de solicitação inválida. Se uma solicitação incluir uma chave excluída ou expirada, a Base39 retornará um erro de autenticação.
Você pode usar os endpoints de API para criar e revogar suas chaves.
Sandbox vs Live
Todas as requisições da API Base39 ocorrem em live ou sandbox. Use o modo sandbox para acessar dados de teste e modo live para acessar os dados reais do seu tenant.
Tipo | Quando usar | Objetos | Considerações |
---|---|---|---|
sandbox | Use as chaves sandbox quando estiver construindo suas integrações. Nesse modo, nenhuma trasação financeira é executada. | Requisições da API retornam objetos simulados. Por exemplo, você deve visualizar company , employment , customer , fund , product , operator e permission . | Algumas integrações de terceiros podem exigir algum documento. Consulte a documentação dos parceiros sobre limitações dos ambientes de teste. |
live | Use as chaves live quando você estiver pronto para executar uma ação real. Transações financeiras serão executadas. | Requisições da API retornam valores reais. | Integrações de terceiro podem exigir homolagações antes de liberar o ambiente de produção. |