Definiciones Generales
Endpoints de la API
| Ambiente | Endpoint de la API | Endpoint de BTG Id |
|---|---|---|
| Sandbox | https://api.sandbox.empresas.btgpactual.com | https://id.sandbox.btgpactual.com |
| Producción | https://api.empresas.btgpactual.com | https://id.btgpactual.com |
Seguridad
HTTPS
Todos los endpoints de la API de BTG Pactual Empresas utilizan el protocolo HTTPS.
OAuth 2
Las APIs de BTG Empresas utilizan el protocolo de autorización OpenID Connect, basado en OAuth2.0, que permite el acceso de aplicaciones de terceros a los recursos del cliente. Para saber más, accede aquí.
📘 BTG Id
El Authorization Server de BTG Empresas se llama BTG Id. Usando BTG Id, una aplicación socia obtiene consentimiento y autorización para ejecutar operaciones en las APIs de BTG en nombre del cliente.
Códigos de retorno
Las APIs de BTG Pactual Empresas usan códigos de respuesta HTTP convencionales para indicar el estado de las solicitudes.
- Códigos 2XX: éxito.
- Códigos 4XX: error en los parámetros enviados a la API por el cliente. Esta clase de errores normalmente requiere un ajuste en las solicitudes.
- Códigos 5XX: error en los servidores de BTG Empresas.
| Status Code | Definición |
|---|---|
| 200 - OK | Solicitud exitosa. |
| 201 - Created | Recurso creado. Este código viene siempre acompañado del header Location con la dirección del recurso creado. |
| 202 - Accepted | Solicitud de operación asíncrona exitosa. |
| 400 - Bad Request | Solicitud inválida. Generalmente ocurre por el envío de parámetros inválidos o la falta de datos para la operación. |
| 401 - Unauthorized | Solicitud no autorizada. Normalmente ocurre por errores relacionados con la autenticación del token. |
| 403 - Forbidden | Solicitud autenticada con éxito, pero el token utilizado no tiene permiso para la operación. |
| 404 - Not Found | El recurso para la solicitud no existe. |
| 409 - Conflict | Solicitud en conflicto con una solicitud anterior. Puede deberse al uso de la misma idempotent key o a que el recurso resultante entra en conflicto con otro recurso ya existente. |
| 429 - Too Many Requests | Demasiadas solicitudes por parte del mismo cliente en un corto espacio de tiempo. |
| 500, 502, 503, 504 - Server Errors | Problema en los servidores de las APIs de BTG Empresas. Para saber más, visita la página de estado. |
Convenciones
Las solicitudes para consumir las APIs de BTG Empresas deben seguir el formato de fecha AAAA-MM-DD y de moneda 000.01.