Autenticación con API Key

¿Es tu método?

Usa esta guía si Blacktrust te entregó una API Key. Si te entregó un correo y una contraseña, tu método es Inicio de Sesión (Bearer). Ambos métodos son alternativos: consulta la visión general de Autenticación.

Blacktrust emite una API Key por cada cliente para el consumo de la API Universal. Esta credencial identifica a tu integración y determina los paquetes y Processes a los que tienes acceso. Con este método no necesitas llamar a /signin: envías la API Key desde la primera petición.

---

Credencial

Credencial	Descripción
API Key	Identificador de tu integración. Debe enviarse en todas las peticiones a la API mediante el encabezado x-api-key.

---

Encabezado Requerido (HTTP Header)

Header	Tipo	Requerido	Valor / Ejemplo
x-api-key	string	Sí	{apiKey}

---

Prefijo de Ruta (/services)

Con el método API Key, los endpoints se exponen bajo el prefijo /services. Las páginas de esta documentación muestran las rutas sin prefijo; agrégalo tú al armar la URL.

Endpoints disponibles con API Key:

Método	Ruta con API Key
POST	/services/candidate-requests
GET	/services/candidate-requests/{uuid}
GET	/services/candidate-requests/{uuid}/processes/{processId}
POST	/services/risks/legal-records/searches
GET	/services/risks/legal-records/searches/{searchId}
GET	/services/risks/legal-records/searches/{searchId}/records/{uuid}

Los demás endpoints (por ejemplo, la carga masiva /bulk-loading/* y la exportación CSV de Riesgo) no están disponibles con API Key.

Método de autenticación	Ruta de ejemplo
API Key	/services/candidate-requests
Usuario y contraseña	/candidate-requests

No olvides el prefijo

Si usas API Key y llamas a {BASE_URL}/candidate-requests (sin /services), la petición no llegará al endpoint correcto.

---

Ejemplo de Petición

cURL

curl -X GET "{BASE_URL}/services/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db" \
     -H "x-api-key: {apiKey}" \
     -H "Content-Type: application/json"

Node.js

const response = await fetch(
  "{BASE_URL}/services/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db",
  {
    method: "GET",
    headers: {
      "x-api-key": apiKey,
      "Content-Type": "application/json",
    },
  },
);

Emisión de Credenciales

La API Key es emitida por el equipo comercial de Blacktrust y se configura a nivel de contrato. Si aún no cuentas con ella, o necesitas rotarla, solicítala a través de tu contacto comercial.

Confidencialidad

No expongas estas credenciales en código de cliente (navegador o aplicaciones móviles), repositorios de código ni capturas de pantalla. Todas las peticiones deben originarse desde tu servidor.