Caso de uso · Integraciones: hablá con otros sistemas · 6 min

API key en un header

El servicio te da una clave y pide mandarla en un header con un nombre propio, como X-Api-Key. Cómo configurarla y ver qué header sale.

Cuándo. La documentación dice “mandá tu clave en el header X-Api-Key” (o api-key, X-Auth-Token, apikey… cada servicio elige su nombre). A diferencia del bearer token, acá no hay Authorization ni la palabra Bearer: el header se llama como el servicio diga y lleva la clave sola.

Qué hace Nxar. Agrega un header con el Nombre que le digas y la clave como valor. La clave se guarda cifrada.

Para ver exactamente qué header sale usamos https://httpbin.org/headers, que devuelve en su respuesta todos los headers que recibió.

Probalo en un workspace de práctica

Un workspace con el escenario ya armado, que se borra solo a las 48 h. Estamos terminándolo.

Muy prontoMientras tanto, hacelo en tu workspace (14 días de prueba)

Creá la integración

ConfiguraciónIntegraciones y APIIntegrations

Nueva Integration: Etiqueta Precios (API key en header), Nombre precios_api_key, Método GET, URL https://httpbin.org/headers. Crear.

Configurá la clave

Editar. En Autenticación, Tipo: API key. Completá:

Enviar en: Header.
Nombre: X-Api-Key. Tal cual lo pide el servicio.
Valor: delsur-demo-key.

Guardar. Volvé a la lista y reabrí la integración: Autenticación dice API key · X-Api-Key (Header).

Bloque Autenticación con Tipo API key, Enviar en Header, Nombre X-Api-Key y Valor enmascarado — Enviar en: Header. El nombre del header es el que pide el servicio.

Probala

Ejecutar Test. httpbin devuelve los headers que le llegaron, y entre ellos está el tuyo:

{
  "headers": {
    "Host": "httpbin.org",
    "X-Api-Key": "delsur-demo-key"
  }
}

(Vas a ver algunos headers más, que agregan Nxar y httpbin. Lo importante es X-Api-Key.)

Test en 200 con la respuesta de httpbin mostrando el header X-Api-Key con la clave — La respuesta muestra el header tal como salió de Nxar.

Si la documentación pide el header Authorization con la clave sola (sin Bearer), también es este tipo: Nombre Authorization y en Valor la clave.

httpbin te devuelve la clave porque es un servicio de prueba. Una API real nunca la devuelve: para verificar, buscá en su documentación un endpoint de consulta simple (por ejemplo, “datos de mi cuenta”) y probalo con Path.

Cómo saber que te salió

Ejecutar Test da 200 y la respuesta incluye "X-Api-Key": "delsur-demo-key".

¿Te funcionó?

En la referencia

Integraciones: autenticación