L’API REST PDFMonkey vous permet de générer des documents PDF à partir de vos modèles en envoyant des requêtes HTTP avec des données JSON. Utilisez-la pour créer des factures, reçus, rapports, attestations et tout PDF à partir de données dynamiques — c’est l’approche idéale pour les workflows automatisés dans votre propre application.

Prérequis

Vous aurez besoin d’un compte PDFMonkey et d’au moins un modèle. Si vous n’avez pas encore créé de modèle, consultez De zéro au premier document.

Générer un PDF

1. Récupérez votre clé API

Récupérez votre clé secrète depuis la page Clé API de votre tableau de bord. Consultez Authentification pour plus de détails.

2. Créez un document

Envoyez une requête POST à /api/v1/documents avec l’identifiant de votre modèle et vos données dynamiques. Le paramètre "status": "pending" lance la génération immédiatement.

Des exemples sont disponibles en curl, Ruby, Node.js, Python et PHP :

curl https://api.pdfmonkey.io/api/v1/documents \
  -X POST \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document": {
      "document_template_id": "YOUR-TEMPLATE-ID",
      "status": "pending",
      "payload": {
        "name": "Jane Doe"
      }
    }
  }'

# generate! attend que le PDF soit prêt avant de retourner le résultat
document = Pdfmonkey::Document.generate!(
  document_template_id: 'YOUR-TEMPLATE-ID',
  payload: { name: 'Jane Doe' }
)

document.status       # => 'success'
document.download_url # => 'https://…'

const response = await fetch('https://api.pdfmonkey.io/api/v1/documents', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_SECRET_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    document: {
      document_template_id: 'YOUR-TEMPLATE-ID',
      status: 'pending',
      payload: { name: 'Jane Doe' },
    },
  }),
});

const data = await response.json();
console.log(data.document);

import requests

response = requests.post(
    'https://api.pdfmonkey.io/api/v1/documents',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    json={
        'document': {
            'document_template_id': 'YOUR-TEMPLATE-ID',
            'status': 'pending',
            'payload': {'name': 'Jane Doe'},
        },
    },
)

print(response.json())

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/documents');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'document' => [
            'document_template_id' => 'YOUR-TEMPLATE-ID',
            'status' => 'pending',
            'payload' => ['name' => 'Jane Doe'],
        ],
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));

L’API renvoie le document avec son statut actuel. Notez l’id — vous en aurez besoin pour vérifier l’avancement de la génération.

{
  "document": {
    "id": "a5e86d72-f5b7-43d4-a04e-8b7e08e6741c",
    "status": "pending",
    "download_url": null,
    ...
  }
}

3. Vérifiez l’état de la génération

Le PDF n’est pas encore prêt — interrogez l’endpoint document_cards jusqu’à ce que le statut atteigne success, puis lisez la download_url.

curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  https://api.pdfmonkey.io/api/v1/document_cards/DOCUMENT_ID
# Quand le statut est "success", le champ download_url contient un lien signé vers le PDF

# Pas nécessaire avec generate! — le document est déjà prêt
card = Pdfmonkey::Document.fetch_card('DOCUMENT_ID')

card.status       # => 'success'
card.download_url # => 'https://…'

const response = await fetch(
  'https://api.pdfmonkey.io/api/v1/document_cards/DOCUMENT_ID',
  {
    headers: {
      'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
  }
);

const data = await response.json();
console.log(data.document_card.status);       // => 'success'
console.log(data.document_card.download_url); // => 'https://…'

import requests

response = requests.get(
    'https://api.pdfmonkey.io/api/v1/document_cards/DOCUMENT_ID',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
)

card = response.json()['document_card']
print(card['status'])       # => 'success'
print(card['download_url']) # => 'https://…'

<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_cards/DOCUMENT_ID');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$card = json_decode($response, true)['document_card'];
echo $card['status'];       // => 'success'
echo $card['download_url']; // => 'https://…'

Plutôt que d’interroger l’API régulièrement, vous pouvez configurer un webhook pour être notifié lorsque le document est prêt. C’est l’approche recommandée en production.

Génération asynchrone vs synchrone

Par défaut, la génération de documents est asynchrone : vous créez le document, puis vous interrogez l’API ou configurez un webhook pour savoir quand il est prêt. C’est l’approche la plus adaptée en production, en particulier pour les gros volumes.

Si vous préférez attendre le résultat en une seule requête, utilisez l’endpoint synchrone /api/v1/documents/sync. C’est pratique pour le prototypage ou les cas d’utilisation interactifs à faible volume. Consultez Génération synchrone pour les détails et les limitations.

Questions fréquentes

Quel format utiliser pour le payload ?

Le champ payload accepte tout objet JSON valide. Sa structure doit correspondre aux variables utilisées dans votre modèle — voir Définir les données dynamiques.

Combien de temps prend la génération d’un PDF ?

La plupart des documents sont prêts en quelques secondes. Les modèles complexes avec de nombreuses pages ou des images volumineuses peuvent prendre plus de temps. Utilisez un webhook pour être notifié dès que le PDF est disponible.

Y a-t-il une limite de requêtes ?

Il n’y a pas de limite stricte sur l’API, mais le quota mensuel de documents de votre plan s’applique. Consultez Nos offres pour les détails des quotas.

Peut-on générer plusieurs PDF en une seule requête ?

Pas directement — chaque appel API génère un document. Pour générer des PDF en masse, envoyez plusieurs requêtes en parallèle ou utilisez une plateforme d’automatisation comme Zapier ou Make.

Référence API Documents — documentation complète des endpoints
Statuts des documents et cycle de vie — comprendre les statuts des documents
L’URL de téléchargement — comment récupérer le PDF généré

Générer des PDF avec l’API