Référence
Le document OpenAPI de votre clé, pour générer un client ou importer l'API dans un outil
Le document OpenAPI de votre clé
L'API décrit elle-même ce qu'une clé peut faire, au format OpenAPI 3.1 :
curl https://acme.deltia.co/api/v1/openapi.json \
-H "Authorization: Bearer dlt_…"Le document est propre à la clé qui le demande : il ne contient que les
entités de sa matrice, les champs que ses rôles lui ouvrent, et les opérations
qu'elle peut réellement faire — pas de POST sans le verbe create, pas de
chemin de devis ou de factures sans le droit correspondant. Chaque entité y a ses propres schémas,
avec ses vrais champs :
{Entité}Record: une fiche, telle que l'API la renvoie ;{Entité}RecordInput: le corps d'une création ;{Entité}RecordPatch: le corps d'une modification.
Le nom de l'entité y est écrit en PascalCase : societes donne
SocietesRecord.
L'utiliser
- Postman, Insomnia, Bruno : importez le fichier téléchargé.
- Générateur de client (openapi-generator, orval…) : pointez-le sur le fichier téléchargé.
- Visualiseur (Scalar, Swagger UI, Redoc) : ouvrez le fichier.
Cache
La réponse porte un ETag et Cache-Control: private, max-age=60. Un outil
qui renvoie l'ETag reçu dans If-None-Match obtient 304 Not Modified tant
que rien n'a changé. Une modification des entités ou des champs du CRM apparaît
dans le document en une minute au plus.