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 via de header 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 object zijn met de waarden die in het sjabloon worden samengevoegd. Er wordt een document gegenereerd door de merge-tags van het sjabloon te vervangen door de waarden van het object. Elke sleutel van het object moet exact overeenkomen met de naam van een tag in het sjabloon, inclusief spaties en hoofdletters.
{
"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 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.
{
"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"
}
De DocuGenerate API werkt met elke programmeertaal die HTTP-verzoeken kan versturen. Onze uitgebreide handleidingen bevatten stapsgewijze instructies voor Node.js, Python, PHP, Ruby, Go, C#, Rust en Java, met kant-en-klare codevoorbeelden voor elke API-methode.
Elke handleiding behandelt de volledige workflow, van het uploaden van een sjabloon tot het genereren en downloaden van documenten. Bekijk alle talen op de overzichtspagina API-SDK's en genereer binnen enkele minuten documenten vanuit uw applicaties.
U vindt een volledige lijst met alle beschikbare eindpunten, inclusief informatie over de request body-parameters en de response schema's, op de pagina API-Referentie.
Deze eindpunten vormen de basis van het DocuGenerate-platform en bieden een uitgebreide set tools voor het beheren van sjablonen en documenten. Door gebruik te maken van deze resources kunt u eenvoudig robuuste workflows voor documentgeneratie bouwen, afgestemd op de specifieke behoeften van uw organisatie.
Bij vragen over de API van DocuGenerate vindt u een schat aan nuttige informatie in ons API-Hulpcentrum.
Ga aan de slag met 20 gratis documenten per maand en doe binnen enkele minuten uw eerste API-aanroep.