Autenticación con API Key
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} |
Ejemplo de Petición
- cURL
- Node.js
curl -X GET "{BASE_URL}/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db" \
-H "x-api-key: {apiKey}" \
-H "Content-Type: application/json"
const response = await fetch(
"{BASE_URL}/candidate-requests/8b9cad0e-1f20-4192-bff0-e1e043cea4db",
{
method: "GET",
headers: {
"x-api-key": apiKey,
"Content-Type": "application/json",
},
},
);
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.
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.