DocuGenerate biedt veilige toegang tot zijn API via het gebruik van API-sleutels, waarmee ontwikkelaars toegang krijgen tot het DocuGenerate-platform en dit kunnen integreren in hun eigen applicaties.
U kunt uw API-sleutel verkrijgen via de Settings-pagina. Om te authenticeren, moet de API-sleutel worden opgenomen in alle API-verzoeken naar de server in een header die er als volgt uitziet:
Authorization: <API Key>
Sjablonen zijn de bouwstenen van DocuGenerate en bieden een manier om hoogwaardige documenten te genereren met consistente opmaak. Met sjablonen kunt u de structuur van uw documenten eenmalig definiëren en ze vervolgens herhaaldelijk gebruiken om naar behoefte nieuwe documenten te genereren.
Om een nieuw sjabloon te maken, moet u een POST-verzoek sturen naar https://api.docugenerate.com/v1/template met de file parameter die verwijst naar het sjabloonbestand. Zorg ervoor dat u multipart/form-data gebruikt als Content-Type bij het maken van het verzoek.
DocuGenerate reageert met een JSON object dat de eigenschappen van het sjabloon bevat, waaronder bijvoorbeeld de lijst met gedetecteerde tags.
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"
}
U genereert documenten door een POST-verzoek te sturen naar https://api.docugenerate.com/v1/document met de parameters template_id en data. U kunt hierbij zowel het multipart/form-data als het application/json Content-Type gebruiken.
De data parameter moet een JSON array zijn met waarden om documenten samen te voegen en te maken op basis van het sjabloon, zoals u in het onderstaande voorbeeld kunt zien. Voor elk object in de array wordt een document gegenereerd door de merge-tags te vervangen door de waarden van het object.
[
{
"Name": "Phip Crowch",
"Job Title": "Help Desk Operator",
"Company Name": "Ortiz Group",
"Street Address": "2971 Tomscot Avenue",
"City": "Annapolis",
"State": "Maryland",
"Zip Code": "21405",
"Email": "pcrowch0@disqus.com",
"Phone": "(443) 3819199"
}
]
Andere parameters zoals output_name, output_format, single_file en page_break kunnen worden opgegeven om de documentgeneratie verder af te stemmen.
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": "Phip Crowch", "Job Title": "Help Desk Operator", "Company Name": "Ortiz Group", "Street Address": "2971 Tomscot Avenue", "City": "Annapolis", "State": "Maryland", "Zip Code": "21405", "Email": "pcrowch0@disqus.com", "Phone": "(443) 3819199" } ]' \
-F 'name=' \
-F 'merge_with=' \
-F 'page_break=true' \
-F 'single_file=true' \
-F 'output_format=.pdf' DocuGenerate reageert met een JSON object dat de eigenschappen van het document bevat, waaronder document_uri dat verwijst naar de URL van het gegenereerde document. Het output_format van het gegenereerde document kan .docx, .pdf, .doc, .odt of .txt zijn. Het is de moeite waard om te weten dat de verwerkingstijd het snelst is voor het .docx formaat. Voor andere formaten is een extra conversiestap nodig, wat de totale responstijd verhoogt.
{
"created": 1748865212803,
"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%2FX5KpzgaMuNoGyiExDum8%2FBusiness%20Letter.pdf?alt=media&token=9c3eaddf-db30-47c5-a3ad-54bdda1d5915",
"id": "X5KpzgaMuNoGyiExDum8"
}
U vindt een uitgebreide lijst met alle beschikbare endpoints, inclusief informatie over de request body-parameters en de response schema's, op de pagina API-Referentie.
Deze endpoints vormen de basis van het DocuGenerate-platform en bieden een uitgebreide set tools voor het beheren van templates en documents. Door gebruik te maken van deze resources kunt u eenvoudig robuuste documentgeneratie-workflows bouwen die kunnen worden aangepast aan de specifieke behoeften van uw organisatie.
Mocht u vragen hebben over het gebruik van de API van DocuGenerate, dan vindt u een schat aan nuttige informatie in ons Hulpcentrum. Het bevat essentiële artikelen die u helpen onze API naadloos te integreren in uw applicaties.
We raden ten zeerste aan de artikelen Test de API met Postman en Test de API met de API-Referentie te raadplegen voor stapsgewijze instructies om effectief met het testen van de API aan de slag te gaan.
