API
Appelez l'API GraphQL depuis votre propre application : authentification, objets principaux et exemples pas à pas.
17 articles
Premiers pas
- À propos de l’APIL’API d’Elium est une API GraphQL : ce qu’elle couvre, les noms qu’elle utilise, où trouver la référence et comment lire ces guides.
- Démarrage rapideFaites votre premier appel à l’API d’Elium avec Insomnia : enregistrez une application connectée, obtenez un jeton et lisez une story.
- AuthentificationComment un programme obtient un jeton d’accès à l’API d’Elium : authorization code avec PKCE, flux password pour les scripts, renouvellement et révocation.
- Identifiants GraphQL et nœudsLa différence entre un slug et un identifiant GraphQL, et comment la requête node lit n’importe quel objet à partir de son identifiant.
Concepts principaux
- Stories, espaces et utilisateursLes objets de l’API d’Elium : une story et ses versions, ses formats de corps, attributs, modèles et assets, son espace et l’utilisateur qui la possède.
- ErreursComment éviter les erreurs sur les mutations en vérifiant actions et dépréciations, et comment lire le champ errors que la plupart d’entre elles renvoient.
Guides pratiques
- Lire une storyLisez une story par son slug avec la requête story, ou par son identifiant GraphQL avec la requête node.
- Lire une story avec ses assetsLisez les fichiers et les liens attachés à une story : des fragments sur FileAsset et URLAsset donnent leurs adresses de téléchargement et leurs miniatures.
- Créer une storyCréez une story avec la mutation storyPost : choisissez l’espace et le format du corps, puis publiez-la ou gardez-la en brouillon.
- Créer une story avec un fichierImportez un fichier pour obtenir un jeton, puis créez une story qui utilise ce fichier comme asset principal.
- Modifier une storyCréez une nouvelle version d’une story avec la mutation storyEdit, par exemple pour remplacer son asset principal par un autre fichier.
- Modifier les tags d’une storyTrouvez ou créez les tags dont vous avez besoin, puis ajoutez et retirez des tags et des hashtags sur une story avec la mutation storyTag.
- Rechercher des stories par tagsUtilisez le champ search de me pour lister les stories qui portent un tag, dans la limite de ce que l’utilisateur a le droit de voir.
- Changer le propriétaire d’une storyDésignez un autre utilisateur comme propriétaire d’une story avec la mutation storyChangeOwner.
- Interroger les statistiquesLisez les chiffres d’activité de toute la plateforme, d’un espace ou d’une story : utilisateurs actifs, activité dans le temps, utilisateurs les plus actifs.
- Poser une question à Elium AnswerObtenez une réponse de l’IA à partir des contenus de votre plateforme, via l’API, avec les stories et les fichiers sur lesquels elle s’appuie.
- Poser une question à un assistant intelligentListez vos assistants intelligents, puis posez une question à l’un d’eux via l’API et lisez ses sources.