Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente | |||
technique:adminserv:etherpad:api [2020/12/31 16:17] – qduchemi | technique:adminserv:etherpad:api [2021/01/04 18:28] (Version actuelle) – qduchemi | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
+ | {{indexmenu_n> | ||
+ | ## Utilisation de l'API d' | ||
+ | |||
+ | Cette page recense quelques cas d' | ||
+ | |||
+ | ### Prérequis | ||
+ | |||
+ | Avant la version 1.8, l'API utilisait **uniquement** des requêtes GET. | ||
+ | Depuis la version 1.8, l'API supporte indifféremment les requêtes GET et POST. | ||
+ | |||
+ | < | ||
+ | |||
+ | L'API permet de créer et de supprimer des pads, ainsi que de gérer les accès aux pads. Chez Picasoft, nous n' | ||
+ | |||
+ | L'API utilise une clé pour se connecter. On peut la récupérer en se rendant dans le conteneur, par exemple : | ||
+ | |||
+ | <code bash> | ||
+ | qduchemi@pica01: | ||
+ | node@id:~$ cat / | ||
+ | </ | ||
+ | |||
+ | Cette clé sera passée en paramètre de la requête, comme valeur du paramètre `apikey`. | ||
+ | |||
+ | La version de l'API est renvoyée sur la route `/api`. | ||
+ | L'API est documentée au format OpenAPI sur `/ | ||
+ | |||
+ | L' | ||
+ | |||
+ | < | ||
+ | |||
+ | ### Suppression d'un pad | ||
+ | |||
+ | Attention, opération définitive. Elle supprime en particulier l' | ||
+ | |||
+ | On utilise la route '' | ||
+ | |||
+ | <code bash> | ||
+ | node@id:~$ curl " | ||
+ | </ | ||
+ | |||
+ | Il est plus sûr d' | ||
+ | |||
+ | <code bash> | ||
+ | node@id:~$ curl " | ||
+ | </ | ||
+ | |||
+ | ### Réponse | ||
+ | |||
+ | L'API répond toujours avec un objet JSON de la forme : | ||
+ | |||
+ | ```json | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ``` | ||
+ | |||
+ | Le code vaut 0 si tout s'est bien passé, sinon le message contiendra une explication sur ce qui s'est mal passé. |