Referencia de API

Esta sección cubre los endpoints estructurales que posibilitan la interacción con la API.

---

Entornos y URLs Base (Base URLs)

Todas las peticiones a los endpoints de los procesos deben concatenarse a estas bases dependiendo del entorno:

Entorno	Base URL
Staging (Ambiente de Pruebas)	https://blacktrustapp-gateway-6ww9slm0.uc.gateway.dev
Production (Ambiente de Producción)	https://blacktrustapp-gateway-c7zdy776.uc.gateway.dev

Prefijo /services con API Key

Las rutas de esta documentación se muestran sin prefijo, tal como se usan con usuario y contraseña. Si tu método de autenticación es API Key, antepón /services a la ruta (solo en los endpoints disponibles con API Key; ver API Key):

Método de autenticación	URL completa de ejemplo
Usuario y contraseña	{BASE_URL}/candidate-requests
API Key	{BASE_URL}/services/candidate-requests

Consulta Autenticación para más detalle.

Encabezados Globales

Todas las solicitudes a la API requieren la inclusión de la siguiente cabecera HTTP:

Content-Type: application/json

Autenticación

Autentícate con el método que Blacktrust definió para tu integración: el header x-api-key o Authorization: Bearer {accessToken} (uno u otro, nunca ambos). Consulta Autenticación para saber cuál aplica en tu caso.

Formato de Respuestas

Todas las respuestas de la API son retornadas en formato JSON con codificación de caracteres UTF-8.

Errores

Consulta el catálogo de Errores para ver, por endpoint, el código HTTP, el errorCode y el message de cada error posible.