API publica de pliego

Contenido publicado desde el administrador, version v1.

Autenticacion

Toda lectura necesita el token del consumidor en una cabecera. Nunca en la URL: ahi quedaria en los logs y en el historial.

Authorization: Bearer pliego_...

Cada token tiene sus entornos y sus secciones. Pedir algo fuera de eso devuelve 403, y un token revocado devuelve 401 desde el momento en que se revoca.

Cache

Las respuestas traen ETag. Mandalo de vuelta en If-None-Match y, si no cambio nada, la respuesta es 304 sin cuerpo. Es la diferencia entre descargar el documento cada vez y no hacerlo.

curl -H "Authorization: Bearer $TOKEN" \
     -H 'If-None-Match: W/"prod-parametros-7"' \
  https://pliego-bff.carlosurquiza.cl/v1/contenido/prod/parametros

Tipos

El endpoint de esquema devuelve el JSON Schema de la seccion. Con eso se generan los tipos del lado del consumidor en vez de escribirlos a mano y desincronizarse.

Endpoints

GET /v1/secciones

Secciones que este token puede leer

Devuelve solo las secciones permitidas para el token, con los entornos a los que tiene acceso.

curl -H "Authorization: Bearer $TOKEN" \
  https://pliego-bff.carlosurquiza.cl/v1/secciones

GET /v1/contenido/{entorno}/{seccion}

Documento publicado

El documento tal como quedo al publicarse. Con ?v=N devuelve esa version en vez de la ultima. Responde ETag; mandar If-None-Match evita descargarlo de nuevo.

curl -H "Authorization: Bearer $TOKEN" \
  https://pliego-bff.carlosurquiza.cl/v1/contenido/prod/parametros

GET /v1/esquema/{entorno}/{seccion}

JSON Schema de la sección

La forma declarada del documento. Sirve para generar tipos en vez de escribirlos a mano.

curl -H "Authorization: Bearer $TOKEN" \
  https://pliego-bff.carlosurquiza.cl/v1/esquema/prod/parametros

GET /v1/versiones/{entorno}/{seccion}

Historial de versiones

Número, quien público, cuando y la nota de cada versión.

curl -H "Authorization: Bearer $TOKEN" \
  https://pliego-bff.carlosurquiza.cl/v1/versiones/prod/parametros

GET /v1/contenido/{entorno}/{seccion}/preview

Borrador sin publicar

El borrador armado desde la base, para probar antes de publicar. Requiere un token con permiso de preview.

curl -H "Authorization: Bearer $TOKEN" \
  https://pliego-bff.carlosurquiza.cl/v1/contenido/prod/parametros/preview

Especificacion

La definicion completa, para generar un cliente: /v1/openapi.json.