Documentation

Fusionner des modèles

L'endpoint de fusion de modèles de notre API vous permet de combiner plusieurs modèles PDF en un seul document PDF.

POST /api/templates/merge

Headers
Authorization*	L'en-tête `Authorization` est utilisé pour authentifier la requête. Vous devez fournir une clé API valide au format `Bearer {token}`. Vous pouvez générer une clé API depuis la page API Tokens. Lisez-en plus sur l'authentification de l'API pour des instructions détaillées.
Accept	Default: application/pdf L'en-tête `Accept` est utilisé pour spécifier le format de la réponse. L'API prend en charge les formats suivants : `application/pdf` - L'API répondra avec un fichier PDF dans le corps de la réponse. `application/json` - L'API répondra avec un objet JSON contenant deux clés : `status` et `data`. La clé `status` contiendra le code de statut HTTP de la réponse, et la clé `data` contient le fichier PDF encodé en base64.
Content-Type	Default: application/json L'en-tête `Content-Type` est utilisé pour spécifier le format de la charge utile de la requête. Il doit être `application/json` ou null.
Request body
templates*	Le paramètre `templates` est envoyé via la charge utile de la requête. Il doit contenir un tableau où chaque élé contient l'identifiant du modèle que vous souhaitez fusionner, ainsi que les données à remplacer dans le modèle. Vous pouvez trouver les identifiants de modèle sur la page index des modèles.
output	Default: pdf Le paramètre `output` est facultatif et peut être utilisé pour spécifier le format de la réponse. L'API prend en charge deux formats de sortie : `pdf` et `url`. Par défaut, ce paramètre est défini sur `pdf` et l'API répondra avec le fichier PDF dans le corps de la réponse. Si le paramètre `output` est défini sur `url`, l'API répondra avec une URL vers le fichier PDF généré. Veuillez noter que l'URL expire après 15 minutes et que le fichier PDF sera supprimé de nos serveurs.

Exemple de requête

Voici un exemple de requête POST vers l'endpoint de fusion de modèles. Dans cet exemple, nous avons un modèle de facture et un modèle d'étiquette d'expédition que nous voulons fusionner en un seul document PDF. Nous utilisons l'outil en ligne de commande curl pour envoyer une requête POST à l'API.

curl -X POST "https://pdf-api.io/api/templates/merge" \
     -H "Content-Type: application/json" \
     -H "Accept: application/pdf" \
     -d '{
         "templates": [
             {
                 "id": "templateId1",
                 "data": {
                     "name": "John Doe",
                     "order_id": "ABC123",
                     "total": "$ 120.00"
                 }
             },
             {
                 "id": "templateId2",
                 "data": {
                     "address": "123 Main St",
                     "city": "New York",
                     "tracking_code": "XYZ789"
                 }
             }
         ]
     }'

Réponse

Contenu PDF

L'API répondra avec un fichier PDF contenant le contenu fusionné des modèles spécifiés. Le contenu de la réponse dépendra de la valeur de l'en-tête Accept dans la requête. Si l'en-tête Accept est défini sur application/pdf, l'API répondra avec des données binaires dans le corps de la réponse. Si l'en-tête Accept est défini sur application/json, l'API répondra avec un objet JSON contenant le fichier PDF encodé en base64.

Réponse JSON

Si l'en-tête Accept est défini sur application/json, l'API répondra avec un objet JSON contenant deux clés : status et data. La clé status contiendra le code de statut HTTP de la réponse, et la clé data contient le fichier PDF encodé en base64.

{
    "status": 200,
    "data": "CONTENT_OF_THE_PDF_FILE"
}

Réponse URL

Si le paramètre output est défini sur url, l'API répondra avec une URL vers le fichier PDF généré.

{
    "status": 200,
    "data": "URL_TO_PDF_FILE"
}

Note

L'URL expirera après 15 minutes, et le fichier PDF sera supprimé de nos serveurs.