Référence de l'API

Essayer

Le bouton Essayer de chaque page envoie un vrai appel :

Dans Serveur, remplacez lekalao.example.com par l’adresse de votre Lekalao.

Dans Authorization, collez un jeton (Paramètres → Jetons d’API).

Le bac à sable agit sur vos vraies données. Utilisez une équipe de test ou un jeton Lecture pour explorer.

En bref


Adresse	`https://votre-lekalao/api/v1`
Authentification	`Authorization: Bearer <jeton>`. Voir Authentification.
Format	JSON ; `Accept: application/json`.
Identifiants	`id`, un uuid.
Pagination	`page`, `per_page` (100 au plus) ; `links` et `meta` dans la réponse.
Limite	120 appels par minute par jeton.
Idempotence	En-tête `Idempotency-Key` sur les écritures, 24 heures.

Le document OpenAPI

Chaque installation sert le sien, à jour de sa version :

curl https://lekalao.example.com/api/v1/openapi.json -o lekalao-openapi.json

Importez-le dans Postman ou Insomnia, ou générez un client :

npx @openapitools/openapi-generator-cli generate \
  -i lekalao-openapi.json -g typescript-fetch -o ./lekalao-client

Le document publié ici est rédigé en français et plus détaillé ; celui de l’installation suit exactement ses routes.

Essayer