Aller au contenu

L'API Louquillou

Tout ce que fait l’application passe par une API HTTP. Elle est documentée au format OpenAPI, ce qui permet de l’explorer et d’en générer des clients.

La documentation interactive de l’API est publiée ici :

docs.api.louquillou.com

Vous y trouverez la liste des points d’entrée, les champs attendus, les formats de réponse et les codes d’erreur, avec la possibilité d’essayer chaque appel directement depuis la page.

La description brute, au format OpenAPI, est servie sur docs.api.louquillou.com/openapi.yaml : c’est le fichier à donner à un générateur de client ou à importer dans Postman.

L’API utilise des jetons. Vous obtenez un jeton d’accès en vous connectant avec vos identifiants habituels, puis vous le transmettez dans l’en-tête Authorization de vos appels, sous la forme Bearer <jeton>.

Le jeton d’accès a une durée de vie courte ; un jeton de rafraîchissement permet d’en obtenir un nouveau sans redemander le mot de passe.

Le plus simple pour démarrer est de passer par l’outil en ligne de commande, qui gère la connexion pour vous.

Le téléversement de documents et de photos se fait en multipart/form-data, et non en JSON comme le reste de l’API. Si vous utilisez un client généré depuis la description OpenAPI, cet appel demande donc un traitement à part — l’outil en ligne de commande le gère déjà avec sa commande documents upload.