Guide du produit et de l’API
Réponse
Contenu de la réponse
Chaque rendu réussi répond avec le même objet. Deux champs méritent d’être conservés : documentId identifie le fichier pendant sa conservation et pageCount détermine la facturation mensuelle.
Réponse
{
"documentId": "doc_5bd26de32c324a4bb8cffad2c80edd01",
"jobId": "job_00b96f006b034258b00b650d724d0207",
"fileName": "invoice-doc_5bd26de32c324a4bb8cffad2c80edd01.pdf",
"format": "pdf",
"templateCode": "invoice",
"templateVersion": 5,
"templateVersionSource": "published",
"downloadUrl": "/api/v1/documents/doc_5bd2.../download/pdf",
"previewUrl": null,
"pageCount": 1,
"quotaRemaining": 4999,
"meteringBasis": "pdf-equivalent",
"createdAt": "2026-08-28T13:23:32+00:00"
}Un rendu reste privé et son téléchargement nécessite votre clé API. Utilisez le point de terminaison d’aperçu uniquement si vous souhaitez créer un lien client temporaire.
En-têtes de réponse
Chaque réponse de rendu reprend les chiffres de consommation dans ses en-têtes pour suivre le quota sans second appel.
X-PDFgine-Pages | Nombre de pages de ce document |
|---|---|
X-PDFgine-Job | Identifiant de la tâche de rendu |
X-PDFgine-Quota-Remaining | Pages restantes après l’opération |
X-PDFgine-Metering-Basis | Unité de comptage |
Champ par champ
Les mêmes champs sont renvoyés pour pdf, docx et html ; seul fileName change.
| Champ | Signification |
|---|---|
documentId | L’identifiant du fichier produit. Les téléchargements, le statut et le partage passent tous par lui ; c’est donc la valeur à conserver. |
downloadUrl | Relative à l’adresse de l’API et récupérée avec la même clé. C’est un chemin, pas un lien public. |
templateVersion | La version du modèle ayant produit ce fichier. Conservez-la pour pouvoir expliquer une réimpression plusieurs mois plus tard. |
templateVersionSource | published pour un rendu de production, draft lorsque purpose valait editor-test. |
pageCount | Le nombre de pages produites ; c’est ce que comptabilise le quota. |
quotaRemaining | Pages restantes dans le mois en cours au moment de cette réponse. |
meteringBasis | Définition d’une page pour la facturation. pdf-equivalent compte une sortie docx ou html comme le nombre de pages qu’aurait le PDF. |
previewUrl | Renseigné uniquement si le document a été partagé ; null sinon. |
Les problèmes les plus courants
- downloadUrl est un chemin. Le coller dans un navigateur sans l’adresse de l’API et la clé renvoie 404 ou 401, pas le fichier.
- Stockez documentId, pas la réponse entière. La rétention supprime les fichiers après la durée prévue par votre offre ; une URL stockée ne pointera alors plus sur rien.
- quotaRemaining est un instantané, pas un compteur en direct. Deux appels simultanés peuvent lire le même nombre.
- pageCount est l’unité de facturation, pas le nombre de fichiers. Un document de dix pages coûte dix pages, que vous demandiez pdf ou docx.
- Un previewUrl égal à null ne signifie pas que le partage a échoué ; ce rendu n’a simplement pas été partagé. Le partage fait l’objet d’un appel distinct.