Definições Gerais
Endpoints da API
| Ambiente | Endpoint da API | Endpoint do BTG Id |
|---|---|---|
| Sandbox | https://api.sandbox.empresas.btgpactual.com | https://id.sandbox.btgpactual.com |
| Produção | https://api.empresas.btgpactual.com | https://id.btgpactual.com |
Segurança
HTTPS
Todos os endpoints da API BTG Pactual Empresas utilizam o protocolo HTTPS.
OAuth 2
As APIs BTG Empresas utilizam o protocolo de autorização OpenID Connect, baseado no OAuth2.0, que permite o acesso de aplicativos terceiros aos recursos do cliente. Para saber mais, acesse aqui.
BTG Id
O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais sobre a autenticação e autorização das APIs do BTG Empresas, acesse a documentação do BTG Id
Códigos de Retorno
As APIs do BTG Pactual Empresas usam códigos de resposta HTTP convencionais para indicar status nas requisições.
- Códigos 2XX: sucesso.
- Códigos 4XX: erro nos parâmetros enviados à API pelo cliente. Esta classe de erros normalmente pede ajuste nas requisições.
- Códigos 5XX: erro nos servidores BTG Empresas.
| Status Code | Definição |
|---|---|
| 200 - OK | Requisição bem sucedida. |
| 201 - Created | Recurso criado. Esse código vem sempre acompanhado da header Location com o endereço do recurso criado. |
| 202 - Accepted | Requisição de operação assíncrona bem sucedida. |
| 400 - Bad Request | Requisição inválida. Geralmente acontece por envio de parâmetros inválidos ou falta de dados para a operação. |
| 401 - Unauthorized | Requisição não autorizada. Normalmente acontece por erros relacionados à autenticação do token. |
| 403 - Forbidden | Requisição autenticada com sucesso, mas o token utilizado não tem permissão para a operação. |
| 404 - Not Found | O recurso para a requisição não existe. |
| 409 - Conflict | Requisição em conflito com requisição anterior. Pode ser pelo uso da mesma idempotent key ou o recurso resultante conflita com outro recurso já existente. |
| 429 - Too Many Requests | Muitas requisições pelo mesmo cliente num curto espaço de tempo. |
| 500, 502, 503, 504 - Server Errors | Problema nos servers das APIs BTG Empresas. Para saber mais, visite a página de status. |
Convenções
As requisições para consumir as APIs BTG Empresas precisam seguir o formato de data AAAA-MM-DD e de moeda 000,01.
Paginação
AAs APIs do BTG Pactual Empresas usam o padrão de offset e limit para paginação de resultados. Os recursos com resultados paginados recebem pelo menos 2 parâmetros comuns:
- limit: limite de resultados por página
- offset: posição que a página inicia
Exemplo
/bank-slips?offset=10&limit=10
Updated 3 months ago