DocuGenerate fournit un accès sécurisé à son API grâce à l'utilisation de clés API, qui permettent aux développeurs d'accéder à la plateforme DocuGenerate et de l'intégrer dans leurs propres applications.
Vous pouvez obtenir votre clé API depuis la page Settings. Pour vous authentifier, la clé API doit être incluse dans toutes les requêtes API au serveur via l'en-tête Authorization: <Clé API>
Les modèles sont les éléments constitutifs de DocuGenerate, offrant un moyen de générer des documents de haute qualité avec une mise en forme cohérente. Avec les modèles, vous pouvez définir la structure de vos documents une seule fois, puis les utiliser pour générer de nouveaux documents selon vos besoins.
Pour créer un nouveau modèle, vous devez envoyer une requête POST à https://api.docugenerate.com/v1/template avec le paramètre file référençant le fichier modèle. Assurez-vous d'utiliser multipart/form-data comme type de contenu lors de la requête.
DocuGenerate répondra avec un objet JSON contenant les propriétés du modèle, incluant par exemple la liste des balises détectées.
curl -X 'POST' \
'https://api.docugenerate.com/v1/template' \
-H 'Accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@Business Letter.docx;type=application/vnd.openxmlformats-officedocument.wordprocessingml.document' \
-F 'name=' \
-F 'delimiters={
"left": "[",
"right": "]"
}' \
-F 'region=us' \
-F 'enhanced_syntax=false' \
-F 'versioning_enabled=true'{
"enhanced_syntax": false,
"versioning_enabled": true,
"tags": {
"valid": [
"Date",
"Name",
"Job Title",
"Company Name",
"Street Address",
"City",
"State",
"Zip Code",
"Email",
"Phone"
],
"invalid": []
},
"created": 1748863881127,
"updated": 1748863881127,
"name": "Business Letter",
"delimiters": {
"left": "[",
"right": "]"
},
"filename": "Business Letter.docx",
"format": ".docx",
"region": "us",
"page_count": 1,
"image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.png?alt=media&token=d534d7f0-ccb6-4d6d-a9cf-7ffa55e82b95",
"preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.pdf?alt=media&token=8f60f256-c454-4ffc-a8da-670431a62e82",
"template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.docx?alt=media&token=0904bdf4-6046-4c03-a612-ebdf145fdee5",
"id": "bet2oQirk0pSd9ctH9Qu"
}
Vous générez des documents en envoyant une requête POST à https://api.docugenerate.com/v1/document avec les paramètres template_id et data. Le type de contenu multipart/form-data ou application/json peut être utilisé.
Le paramètre data doit être un objet JSON avec les valeurs à fusionner dans le modèle. Un document sera généré en remplaçant les balises de fusion du modèle par les valeurs de l'objet. Chaque clé de l'objet doit correspondre exactement au nom d'une balise du modèle, y compris les espaces et les majuscules.
{
"Name": "Emily Carter",
"Job Title": "Operations Manager",
"Company Name": "Harbor Point Consulting",
"Street Address": "118 West Street",
"City": "Annapolis",
"State": "Maryland",
"Zip Code": "21405",
"Email": "emily.carter@example.com",
"Phone": "(410) 555-0142"
}
curl -X 'POST' \
'https://api.docugenerate.com/v1/document' \
-H 'Accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'template_id=bet2oQirk0pSd9ctH9Qu' \
-F 'output_quality=100' \
-F 'attach=' \
-F 'output_name=' \
-F 'data={ "Name": "Emily Carter", "Job Title": "Operations Manager", "Company Name": "Harbor Point Consulting", "Street Address": "118 West Street", "City": "Annapolis", "State": "Maryland", "Zip Code": "21405", "Email": "emily.carter@example.com", "Phone": "(410) 555-0142" }' \
-F 'name=' \
-F 'merge_with=' \
-F 'page_break=true' \
-F 'single_file=true' \
-F 'output_format=.pdf' DocuGenerate répondra avec un objet JSON contenant les propriétés du document, notamment document_uri qui pointe vers l'URL du document généré. Le output_format du document généré peut être .docx, .pdf, .doc, .odt ou .txt.
{
"created": 1791125416372,
"template_id": "bet2oQirk0pSd9ctH9Qu",
"name": "Business Letter",
"format": ".pdf",
"data_length": 1,
"filename": "Business Letter.pdf",
"document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FiESelthRt4uaYQRTemrL%2FBusiness%20Letter.pdf?alt=media&token=c4b259ec-249b-4b35-a62f-6a8dc0da75f3",
"id": "iESelthRt4uaYQRTemrL"
}
L'API DocuGenerate fonctionne avec tout langage de programmation capable d'envoyer des requêtes HTTP. Nos guides détaillés incluent des instructions étape par étape pour Node.js, Python, PHP, Ruby, Go, C#, Rust et Java, avec des exemples de code prêts à l'emploi pour chaque méthode de l'API.
Chaque guide couvre l'ensemble du processus, de l'envoi d'un modèle à la génération et au téléchargement des documents. Retrouvez tous les langages sur la page dédiée SDK API et commencez à générer des documents depuis vos applications en quelques minutes.
Vous pouvez trouver une liste complète de tous les endpoints disponibles, incluant des informations sur les paramètres du corps de la requête et les schémas de réponse, sur la page Référence API.
Ces endpoints constituent le fondement de la plateforme DocuGenerate, fournissant un ensemble exhaustif d'outils pour gérer les modèles et les documents. En exploitant ces ressources, vous pouvez facilement créer des flux de génération de documents robustes, adaptés aux besoins spécifiques de votre organisation.
Pour toute question sur l'API de DocuGenerate, vous trouverez une multitude de ressources utiles dans notre Centre d'Aide API.
Démarrez avec 20 documents gratuits par mois et effectuez votre premier appel API en quelques minutes.