Référence API¶
Administration → API → Reference.
Cette page présente les points d'accès exposés par votre instance, lus dans son propre schéma. Elle
remplace les pages /docs et /redoc des versions précédentes, qui étaient servies sans
authentification.
Ce que la page contient¶
Le schéma décrit l'intégralité de l'API : les points d'accès, leurs paramètres, la forme des corps de requête et celle des réponses. Il est produit par l'instance elle-même, il correspond donc toujours à la version que vous avez installée, sans risque de décalage avec une documentation publiée séparément.
Les requêtes envoyées depuis cette page utilisent votre session en cours. Elles portent donc vos propres permissions : ce que vous ne pouvez pas faire dans l'interface, vous ne pouvez pas le faire depuis cette page non plus.
Les essais sont réels
La fonction d'essai d'un point d'accès exécute une véritable requête sur votre instance, avec vos droits. Un appel qui crée, modifie ou supprime le fait pour de bon.
Récupérer le schéma depuis un outil¶
Le schéma est disponible sur /openapi.json, à la racine de l'instance, et demande une
authentification. Deux identités sont acceptées :
- une session utilisateur, ce qu'utilise cette page ;
- une clé d'API, l'en-tête
X-API-Key, ce qui permet à un intégrateur de charger le schéma dans son propre outillage.
Les clés d'API se créent dans Administration → API → Keys.
L'adresse ne s'ouvre pas dans un navigateur
Une navigation classique ne transporte pas d'en-tête d'authentification, l'adresse répond donc par un refus si vous la saisissez dans la barre du navigateur. Utilisez un outil capable de poser l'en-tête, ou cette page.