Démarrage rapide

Cinq minutes pour votre premier document

Cette page vous mène de zéro à un PDF sur disque. Elle utilise le modèle de facture fourni avec chaque espace de travail ; vous n’avez donc rien à concevoir au préalable.

1. Votre clé

Créez une clé dans Compte → Clés API. Le secret n’est affiché qu’une fois ; gardez-le hors de votre code source. Chaque appel le transmet dans l’en-tête X-PDFgine-Key.

# La clé se trouve dans l’environnement, pas dans le code
export PDFGINE_KEY="pdfgine_live_..."

# Cela fonctionne-t-il ? Cet appel liste vos modèles
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. Produisez un document

Un appel avec le code du modèle et vos données. La réponse est 202 avec un documentId et une URL de téléchargement.

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "fr",
        "data": {
          "document": { "title": "Résumé de la facture" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "Diagnostic des pannes", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

Lorsque vous testez un modèle, envoyez "purpose": "editor-test" : cette sortie ne consomme aucun quota et utilise le brouillon non publié.

3. Téléchargez-le

L’URL de téléchargement de la réponse est relative à l’adresse de l’API et s’utilise avec la même clé. Demandez docx au lieu de pdf pour recevoir les mêmes données dans un fichier Word.

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

Les premiers problèmes les plus courants

• 402 signifie que le quota mensuel de pages est épuisé ; l’en-tête X-PDFgine-Quota-Remaining vous prévient avant d’y arriver.
• 422 signifie que vos données ne respectent pas le modèle. Le corps liste chaque champ manquant dans errors ; vous n’avez pas à deviner lequel.
• Le rendu répond 202, pas 200. Un client qui considère toute réponse autre que 200 comme un échec signalera une réussite comme erreur.

Pour aller plus loin

Formats de données est la page que vous consulterez le plus : elle indique précisément comment doivent être envoyés une date, un montant et une devise.