Documentation

Modèles

Obtenir une liste des modèles disponibles

Pour obtenir tous les modèles, envoyez une requête GET à /api/templates. Vous recevrez une réponse JSON contenant tous les modèles.

GET /api/templates

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 un jeton API à partir de la page Jetons API. Lisez plus sur l'authentification API pour des instructions détaillées.
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. Cela doit être `application/json` ou null.

Exemple de requête

Voici un exemple de requête GET vers le point de terminaison des modèles. Dans cet exemple, nous utilisons l'outil en ligne de commande curl pour envoyer une requête GET à l'API.

curl -X GET "https://pdf-api.io/api/templates" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {token}"

Exemple de réponse

La réponse sera un tableau JSON contenant des objets de modèle. Chaque objet de modèle comprend les champs suivants :

id : L'identifiant unique du modèle
name : Le nom du modèle
type : Le type du modèle (par exemple, "editor" ou "html")
created_at : La date de création du modèle
meta : Métadonnées supplémentaires associées au modèle
variables : Un tableau de variables utilisées dans le modèle

Voici un exemple de la structure de réponse :

[
  {
    "id": "1234567890",
    "name": "Invoice Template",
    "type": "editor",
    "created_at": "2023-04-15T10:30:00Z",
    "meta": {
      "description": "A simple invoice template"
    },
    "variables": [
      {
        "name": "customer_name",
        "type": "string"
      },
      {
        "name": "invoice_items",
        "type": "array"
      },
      {
        "name": "invoice_items[]",
        "type": "object"
      },
      {
        "name": "invoice_items[].description",
        "type": "string"
      },
      {
        "name": "invoice_items[].amount",
        "type": "string"
      }
    ]
  }
]

Comprendre le champ `variables`

Le champ variables fournit des informations sur le contenu dynamique qui peut être inséré dans le modèle. Chaque objet variable dans le tableau contient :

name : Le nom de la variable, qui peut être utilisé pour remplir le modèle avec des données
type : Le type de données attendu pour la variable (par exemple, "string", "array" ou "object")

Pour les variables de type tableau, vous remarquerez trois entrées connexes :

Le tableau lui-même (par exemple, invoice_items)
Une entrée pour les éléments du tableau (par exemple, invoice_items[])
Les champs individuels au sein des éléments du tableau (par exemple, invoice_items[].description)

Cette structure vous permet de comprendre comment formater vos données lors de l'utilisation du modèle, en particulier pour des structures complexes comme des tableaux ou des sections répétables.