API de contenido
Lee los artículos publicados de un espacio en JSON con una llave ul_ct_ y muéstralos en tu sitio o tu aplicación con tu propio diseño.
En esta página
La API de contenido entrega los artículos publicados de un espacio de Conocimiento en JSON, para que tu sitio o tu aplicación los muestre con su propio diseño. Es la alternativa al centro de ayuda de Elion ITSM cuando quieres tu propia página de ayuda.
Antes de empezar
Necesitas el nivel de administrador en Configuración (rol Administrador).
Debe existir el espacio con las páginas publicadas.
Elegir el tipo de llave
Tipo | Para qué | Qué puede leer |
|---|---|---|
Navegador (sitio público del cliente) | El JavaScript de tu sitio web llama directo a la API. | Solo un espacio Pública, y solo desde los Sitios permitidos que indiques. |
Servidor (también páginas internas) | Tu servidor llama a la API y entrega el contenido a tu aplicación. | Cualquier espacio no archivado, también Interno o Portal. Se rechaza si se usa desde un navegador. |
Una llave de Servidor puede leer páginas internas. Guárdala como secreto en tu servidor; nunca la pongas en el código de una página web ni en una app móvil.
Crear una llave
Entra a Configuración → Centro de ayuda y abre la pestaña Importación.
En la tarjeta API de contenido, elige el Espacio y presiona Crear llave.
Completa Nombre, Tipo, Sitios permitidos (obligatorio para Navegador, por ejemplo
https://www.miempresa.cl) y Vence (En 90 días, En 180 días, En un año o Sin vencimiento).Presiona Crear llave, copia la llave con Copiar llave y presiona Listo, ya la copié.
La llave se ve una sola vez. En la tabla puedes Rotar una llave (la nueva hereda todo y la anterior sigue sirviendo 24 horas) o Revocar una llave (deja de servir al instante). Cada espacio admite hasta 10 llaves vigentes.
Pedir el contenido
Todas las peticiones son GET a https://api-itsm.argunis.com/api/public/content/v1/… con la cabecera Authorization: Bearer ul_ct_…. El espacio sale de la llave.
Ruta | Qué entrega |
|---|---|
| Nombre, descripción y cantidad de páginas del espacio. |
| El menú: cada página con |
| Una página por su ruta. |
| Una página por su número. |
| Búsqueda de texto completo (hasta 50 resultados). |
| Páginas que cambiaron o dejaron de estar publicadas desde esa fecha (hasta 1.000), para mantener tu copia al día. |
| Una imagen de una página, con la misma llave. |
curl -H "Authorization: Bearer ul_ct_…" \
"https://api-itsm.argunis.com/api/public/content/v1/pages?path=/primeros-pasos/iniciar-sesion"Una página trae title, description, labels, html, toc (índice de títulos), breadcrumbs, prev, next, updatedAt y version.
El
htmlya viene limpio, con los mismos elementos que acepta la base de conocimiento. Puedes insertarlo en tu página.Los enlaces entre páginas vienen como
/<espacio>/<ruta>. Cámbialos por las rutas de tu sitio.Las imágenes apuntan a
/api/public/content/v1/assets/<id>y se piden con la misma llave.Si la ruta cambió, responde
{ "redirect": "/ruta-nueva" }.
Qué no entrega
Borradores, versiones anteriores, comentarios, valoraciones ni páginas de espacios archivados.