Integratie met Backendless

Hulpcentrum

Backendless homepage

Backendless biedt u de mogelijkheid om te integreren met DocuGenerate om documentcreatie toe te voegen aan uw backend. Door de kracht van Backendless te combineren met de robuuste functies van DocuGenerate, kunt u uw workflows automatiseren en uw activiteiten efficiënt opschalen.

Samenvatting

1. De DocuGenerate API Service Installeren
2. Document Genereren (Operation)
3. Documenten Weergeven (Operation)
4. Document Ophalen (Operation)
5. Document Bijwerken (Operation)
6. Document Verwijderen (Operation)
7. Sjablonen Weergeven (Operation)
8. Sjabloon Ophalen (Operation)
9. Sjabloon Verwijderen (Operation)

1. De DocuGenerate API Service Installeren

Ga om te beginnen naar de sectie API Services in de Backendless Marketplace en zoek de DocuGenerate-service. Klik op de knop GET om DocuGenerate te installeren in uw account en volg de instructies om de service te configureren met uw API-sleutel.

DocuGenerate installeren vanuit de marketplace

Ga naar uw accountinstellingen van DocuGenerate om uw API-sleutel te verkrijgen, en voer deze in bij het configuratievenster als waarde voor het veld API Key.

De DocuGenerate API-sleutel configureren in Backendless

2. Document Genereren (Operation)

Deze operatie maakt een document op basis van een opgegeven sjabloon en dataset. Definieer de naam, bestandsnaam en het formaat van het document, en geef de data op om velden in het sjabloon in te vullen. De volgende parameters zijn aanpasbaar:

  • Template ID: Geeft het te gebruiken sjabloon op.
  • Name: Naam van het gegenereerde document.
  • Output Name: Bestandsnaam van het gegenereerde document.
  • Output Format: Uitvoerformaat (bijv. .pdf, .docx, .doc, .odt, .txt, .html, .png).
  • Data: JSON-data om velden in het sjabloon in te vullen.

Operation om een document te genereren

3. Documenten Weergeven (Operation)

Haalt een lijst op van documenten die zijn gegenereerd op basis van een specifiek sjabloon, zodat u eerder gegenereerde documenten met betrekking tot een sjabloon kunt volgen of weergeven. Het vereist de volgende parameter:

  • Template ID: Geeft aan voor welk sjabloon documenten moeten worden weergegeven.

Operation om documenten weer te geven

4. Document Ophalen (Operation)

Deze operatie haalt metadata op voor een specifiek document, zoals de bestandsnaam, het formaat en de document-URI. De volgende parameter is vereist:

  • id: Geeft de ID op van het document dat moet worden opgehaald.

Operation om een document op te halen

5. Document Bijwerken (Operation)

Gebruik deze operatie om details van een bestaand document te wijzigen, zoals het bijwerken van de naam van het document. De volgende parameters worden verwacht:

  • id: Geeft de ID op van het document dat moet worden bijgewerkt.
  • Name: Bijgewerkte naam van het document.

Operation om een document bij te werken

6. Document Verwijderen (Operation)

Deze operatie verwijdert een document uit uw DocuGenerate-account. Het vereist de volgende parameter:

  • id: Geeft de ID op van het document dat moet worden verwijderd.

Operation om een document te verwijderen

7. Sjablonen Weergeven (Operation)

Haalt een lijst op van alle sjablonen die zijn opgeslagen in uw DocuGenerate-account, inclusief basisgegevens zoals sjabloonnamen en ID’s. Deze operatie vereist geen parameters.

Operation om sjablonen weer te geven

8. Sjabloon Ophalen (Operation)

Deze operatie haalt gedetailleerde informatie op voor een specifiek sjabloon, met behulp van de unieke ID van het sjabloon. U krijgt toegang tot eigenschappen zoals de naam, tags en het formaat van het sjabloon. Het vereist de volgende parameter:

  • id: Geeft de ID op van het sjabloon dat moet worden opgehaald.

Operation om een sjabloon op te halen

9. Sjabloon Verwijderen (Operation)

Verwijder een sjabloon uit uw DocuGenerate-account. Het vereist de volgende parameter:

  • id: Geeft de ID op van het sjabloon dat moet worden verwijderd.

Operation om een sjabloon te verwijderen