From e4568b410fb058203da5a79a7a513a624c0fed4e Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Wed, 23 Dec 2020 19:19:46 +0100 Subject: [PATCH] How to authenticate on the API? Signed-off-by: Yohann D'ANELLO --- docs/apps/api.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/apps/api.rst b/docs/apps/api.rst index 56d6b5df..41087ec4 100644 --- a/docs/apps/api.rst +++ b/docs/apps/api.rst @@ -39,11 +39,23 @@ La page ``/api//`` affiche la liste de tous les éléments enregistrés. les attributs d'un objet uniquement. L'affichage des données peut se faire sous deux formes : via une interface HTML propre ou directement en affichant -le JSON brut. Le changement peut se faire en ajoutant en paramètre de l'URL ``format=json`` ou ``format=api`, ou bien -en plaçant en en-tête de la requête ``Accept: application/json`` ou ``text/html``. +le JSON brut. Le changement peut se faire en ajoutant en paramètre de l'URL ``format=json`` ou ``format=api``, ou bien +en plaçant en en-tête de la requête ``Accept: application/json`` ou ``Accept: text/html``. L'API Web propose des formulaires facilitant l'ajout et la modification d'éléments. +S'authentifier +~~~~~~~~~~~~~~ + +L'authentification peut se faire soit par session en se connectant via la page de connexion classique, +soit via un jeton d'authentification. Le jeton peut se récupérer via la page de son propre compte, en cliquant +sur le bouton « `Accès API `_ ». Il peut être révoqué et regénéré +en un clic. + +Pour s'authentifier via ce jeton, il faut ajouter l'en-tête ``Authorization: Token `` aux paramètres HTTP. + +En s'authentifiant par cette méthode, les masques de droit sont ignorés, les droits maximaux sont accordés. + GET ~~~