API de contenu
Lisez les articles publiés d'un espace en JSON avec une clé ul_ct_ et affichez-les sur votre site ou dans votre application avec votre propre design.
Sur cette page
L'API de contenu fournit en JSON les articles publiés d'un espace de Connaissances, pour que votre site ou votre application les affiche avec son propre design. C'est l'alternative au centre d'aide d'Elion ITSM quand vous voulez votre propre page d'aide.
Avant de commencer
Vous devez disposer du niveau administrateur dans Paramètres (rôle Administrateur).
L'espace doit exister et contenir des pages publiées.
Choisir le type de clé
Type | À quoi elle sert | Ce qu'elle peut lire |
|---|---|---|
Navigateur (site public du client) | Le JavaScript de votre site web appelle directement l'API. | Uniquement un espace Public, et seulement depuis les Sites autorisés que vous indiquez. |
Serveur (pages internes aussi) | Votre serveur appelle l'API et transmet le contenu à votre application. | N'importe quel espace non archivé, y compris Interne ou Portail. Refusée si elle est utilisée depuis un navigateur. |
Une clé Serveur peut lire des pages internes. Conservez-la comme secret sur votre serveur ; ne la placez jamais dans le code d'une page web ni dans une application mobile.
Créer une clé
Ouvrez Paramètres → Centre d'aide et l'onglet Importation.
Dans la carte API de contenu, choisissez l'Espace et cliquez sur Créer une clé.
Remplissez Nom, Type, Sites autorisés (obligatoire pour Navigateur, par exemple
https://www.miempresa.cl) et Expire (Dans 90 jours, Dans 180 jours, Dans un an ou Sans expiration).Cliquez sur Créer une clé, copiez la clé avec Copier la clé et cliquez sur C'est fait, je l'ai copiée.
La clé n'est affichée qu'une seule fois. Dans le tableau, vous pouvez Renouveler une clé (la nouvelle hérite de tout et l'ancienne reste valable 24 heures) ou Révoquer une clé (elle cesse immédiatement de fonctionner). Chaque espace accepte jusqu'à 10 clés valides.
Demander le contenu
Toutes les requêtes sont des GET vers https://api-itsm.argunis.com/api/public/content/v1/… avec l'en-tête Authorization: Bearer ul_ct_…. L'espace est déduit de la clé.
Route | Ce qu'elle fournit |
|---|---|
| Nom, description et nombre de pages de l'espace. |
| Le menu : chaque page avec |
| Une page par son chemin. |
| Une page par son numéro. |
| Recherche en texte intégral (jusqu'à 50 résultats). |
| Les pages modifiées ou dépubliées depuis cette date (jusqu'à 1 000), pour garder votre copie à jour. |
| Une image d'une page, avec la même clé. |
curl -H "Authorization: Bearer ul_ct_…" \
"https://api-itsm.argunis.com/api/public/content/v1/pages?path=/primeros-pasos/iniciar-sesion"Une page contient title, description, labels, html, toc (table des titres), breadcrumbs, prev, next, updatedAt et version.
Le
htmlest déjà nettoyé, avec les mêmes éléments que ceux acceptés par la base de connaissances. Vous pouvez l'insérer dans votre page.Les liens entre pages se présentent sous la forme
/<espacio>/<ruta>. Remplacez-les par les routes de votre site.Les images pointent vers
/api/public/content/v1/assets/<id>et se demandent avec la même clé.Si le chemin a changé, la réponse est
{ "redirect": "/ruta-nueva" }.
Ce qu'elle ne fournit pas
Les brouillons, les versions antérieures, les commentaires, les évaluations ni les pages d'espaces archivés.