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

API key en la URL

Servicios que piden la clave como parámetro de la dirección (?api_key=…). Cómo cargarla sin dejarla escrita en la URL de la integración.

Cuándo. La documentación muestra llamadas como https://api.servicio.com/v1/datos?api_key=TU_CLAVE o ?key=…, ?token=…. Lo hacen muchos servicios de mapas, clima o cotizaciones.

Qué hace Nxar. Agrega el parámetro a la dirección en cada llamada, con el Nombre y el Valor que configures. No escribas la clave dentro de la URL de la integración: ahí queda a la vista de cualquiera que abra la ficha. Cargada como API key, se guarda cifrada y el registro de llamadas anota la dirección sin los parámetros.

Para probarlo usamos https://httpbin.org/get, que devuelve en args los parámetros 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 Clima (API key en la URL), Nombre clima_api_key, Método GET, URL https://httpbin.org/get. Crear.

Configurá la clave como parámetro

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

Enviar en: Query param.
Nombre: api_key. Es el nombre del parámetro, tal cual lo escribe el servicio.
Valor: delsur-demo-key.

En Registro de llamadas, marcá Registrar cada llamada a esta integración. Guardar, volvé a la lista y reabrí la integración: Autenticación dice API key · api_key (Query param).

Bloque Autenticación con Tipo API key, Enviar en Query param y Nombre api_key — Enviar en: Query param. La clave se suma a la dirección al momento de llamar.

Probala

Ejecutar Test. En la respuesta, args tiene tu parámetro y url muestra la dirección completa que usó Nxar:

{
  "args": {
    "api_key": "delsur-demo-key"
  },
  "url": "https://httpbin.org/get?api_key=delsur-demo-key"
}

Mirá el registro

En Llamadas recientes, Refrescar. La fila del Test muestra la URL https://httpbin.org/get, sin ?api_key=…: la clave no queda en el registro.

Llamadas recientes con una fila GET 200 de origen Test y la URL sin el parámetro api_key — El registro guarda la dirección sin parámetros, para no dejar la clave anotada.

Si una llamada desde una automation suma un Path, el parámetro se agrega igual al final. No hace falta repetirlo en el Path.

Cómo saber que te salió

Ejecutar Test da 200 con "api_key": "delsur-demo-key" en args, y en Llamadas recientes la URL aparece sin la clave.

¿Te funcionó?

En la referencia

Integraciones: autenticación