Documentation

Premiers pas

Conventions

  • Tous les chemins ci-dessous sont relatifs à l’URL de base. Requêtes et réponses sont en JSON ; envoyez Content-Type: application/json sur les POST.
  • Les identifiants sont des UUID. Les horodatages sont en ISO 8601, en UTC.
  • Les champs sont désignés par leur clé, un nom en snake_case tel que client_name que l’endpoint de modèle renvoie à côté de chaque libellé. Elle est dérivée du libellé lors du premier enregistrement du modèle et ne bouge plus quand le libellé est reformulé ; l’auteur peut la modifier dans le modèle.
  • Les réponses portent Cache-Control: no-store et des en-têtes CORS permissifs : un client dans le navigateur fonctionne, mais un navigateur n’est pas le bon endroit pour un jeton d’API.
  • L’API est versionnée dans le chemin. Des champs peuvent être ajoutés aux réponses sans changement de version ; rien n’est retiré ni renommé au sein de v1.