Manual · 7

Endpoints personalizados

Vincula un script a una ruta HTTP propia bajo /api/v1/scripts/*.

Configuración:

  • Método HTTP (cualquiera).
  • Patrón de ruta – se permiten segmentos fijos, parámetros con nombre (:id) y un comodín final (*), por ejemplo /pedidos/:id/estado. Si varios patrones registrados coinciden con una solicitud, gana el más específico (fijo antes que parámetro con nombre antes que comodín).
  • Modo de autenticación: público (accesible sin iniciar sesión) o autenticado (se necesita sesión o token de API).

El objeto request

El script tiene disponible un objeto global request:

request.method   // "GET", "POST", ...
request.path     // la ruta invocada
request.params   // parámetros de ruta con nombre, p. ej. { id: "42" }
request.query    // parámetros de la cadena de consulta
request.headers  // cabeceras HTTP
request.body     // JSON analizado, si no el texto sin procesar

La respuesta

Ya sea mediante el objeto response (encadenable):

response.status(201).json({ ok: true });
// o: response.send("texto plano");
// o: response.setHeader("X-Custom", "valor");

O simplemente la última expresión/valor de return del script – se devuelve entonces automáticamente como JSON, sin ninguna llamada a response.*.