Générer un PDF via l'API

Bienvenue dans notre guide sur la génération d'un document PDF à l'aide de notre API. Cette page vous guidera à travers le processus de création d'un PDF à partir de votre modèle personnalisé, d'authentification avec notre API et de l'envoi de votre première requête. Que vous soyez un développeur chevronné ou novice en matière d'intégrations API, ce guide est conçu pour vous offrir un chemin direct vers le succès.

Prérequis

Pour suivre ce guide, vous devez vous inscrire à un compte PDF-API.io. Si vous n'avez pas encore de compte, vous pouvez en créer un gratuitement.

Étape 1 : Créez votre modèle PDF

Avant de pouvoir générer un PDF, vous devez concevoir votre modèle à l'aide de notre outil visuel. Ce modèle peut inclure des éléments statiques ainsi que des variables pour des données dynamiques.

Accédez au concepteur de modèles : Connectez-vous à votre compte et accédez à la page "Templates". Ici, vous pouvez créer un nouveau modèle ou modifier un modèle existant.

Concevez votre modèle : Utilisez l'interface glisser-déposer pour concevoir votre modèle PDF. Vous pouvez ajouter du texte, des images et d'autres éléments au besoin.

Définissez des variables :

Identifiez les parties de votre modèle où des données dynamiques seront insérées. Attribuez des noms de variables uniques à ces sections pour une référence facile. Vous pouvez utiliser les noms de variables dans le concepteur de modèles en les enveloppant dans des accolades, comme ceci : {nom_variable}. Par exemple, si vous souhaitez insérer le nom du client dans votre modèle, vous pouvez ajouter une variable nommée nom_client et l'utiliser dans le modèle comme ceci : Bonjour {nom_client}.

Si vous souhaitez utiliser une variable dans un tableau, vous pouvez utiliser la même syntaxe. Par exemple, si vous souhaitez afficher une liste d'articles dans un tableau, vous pouvez définir une ligne de tableau comme répétable, donner un nom de variable à la ligne de tableau, puis utiliser le nom de la variable dans les cellules du tableau.

Vous pouvez en savoir plus sur l'utilisation des variables dans notre documentation de l'editeur.

Étape 2 : Authentification avec l'API

Pour assurer une communication sécurisée entre votre application et notre API, vous devrez authentifier chaque requête.

1. Obtenez votre clé API : Accédez à la page "API Tokens" et créez une clé API. Gardez cette clé confidentielle. Vous ne pourrez pas afficher cette clé à nouveau après l'avoir générée.
2. Incluez votre clé API dans chaque requête : Lorsque vous effectuez des requêtes vers notre API, incluez cette clé dans l'en-tête pour l'authentification. L'en-tête devrait ressembler à ceci : Authorization: Bearer VOTRE_CLÉ_API.

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

Étape 3 : Générez votre PDF

Maintenant que vous avez votre modèle et votre clé API, vous êtes prêt à générer un PDF.

Préparez vos données : Rassemblez les données dynamiques qui rempliront les variables de votre modèle.

Créez la requête : Construisez une requête HTTP POST vers le point de terminaison de génération de PDF de notre API. La requête doit inclure : - L'ID de votre modèle. Vous pouvez trouver cet ID dans la page templates. - Les données dynamiques au format JSON.

Envoyez la requête :

Utilisez un outil comme cURL ou Postman, ou écrivez un script dans votre langage de programmation préféré pour envoyer la requête. Voici un exemple de base utilisant cURL :

curl -X POST "https://pdf-api.io/api/templates/{templateId}/pdf" \
     -H "Content-Type: application/json" \
     -H "Accept: application/pdf" \
     -H "Authorization: Bearer {token}"
     -d '{
         "data": {
             "name": "John Doe",
             "order_id": "ABC123",
             "total": "$ 120.00",
         }
     }'

Conclusion

Félicitations ! Vous venez d'apprendre à créer un PDF à l'aide de notre API. Ce processus peut être personnalisé et automatisé pour répondre à vos besoins spécifiques. Pour obtenir une assistance supplémentaire ou explorer des fonctionnalités plus avancées, veuillez consulter notre documentation complète de l'API ou contacter notre équipe d'assistance.