Guide du produit et de l’API

Adresse de base

Adresse de base

Tous les points de terminaison se trouvent sous ce préfixe. Dans une installation locale, l’adresse par défaut est celle indiquée ci-dessous.

https://api.pdfgine.com/api/v1

Pagination des points de terminaison de liste

Cinq points de terminaison de liste sont paginés : /history d’un modèle, /assets, /marketplace/templates, /templates et /components. Chacun accepte limit (1-200) et before, facultatifs, et répond toujours par un simple tableau ; les clients actuels n’ont rien à changer.

Sans limit, vous recevez au plus 200 lignes ; s’il en existe davantage, la réponse contient un en-tête Link avec rel="next". Suivez ce lien plutôt que de construire l’URL suivante : le curseur est un numéro de version pour history, un ID de ressource pour assets et une valeur opaque ailleurs ; seul l’en-tête connaît le format. Sur /marketplace/templates, le curseur contient aussi les filtres ; il cesse donc de fonctionner dès que search, category ou locale change. C’est volontaire, car le même curseur pointerait sinon vers une autre liste. Les autres points de terminaison de liste renvoient des collections déjà bornées. Une réponse tronquée contient aussi X-PDFgine-List-Truncated: true et X-PDFgine-List-Limit ; ces deux en-têtes sont absents de la dernière page.

La description exploitable par les machines

Tout ce qui figure sur ces pages est également publié sous forme de document OpenAPI 3.0. Orientez votre générateur de clients, Postman ou votre éditeur vers ce document pour obtenir les chemins, corps de requêtes et exemples de données sans copie manuelle.

OpenAPI 3.0
https://api.pdfgine.com/openapi/v1.json

Le document est généré à partir de l’API en cours d’exécution ; il décrit donc la version réellement appelée, et non celle que quelqu’un a pensé à documenter.