Integratie met Xano

Hulpcentrum

Xano homepage

Xano biedt u de mogelijkheid om te integreren met DocuGenerate om documentcreatie toe te voegen aan uw backend. Onze snippet biedt aangepaste functies voor het beheren van sjablonen en het genereren van documenten, waarmee u workflows automatiseert en moeiteloos hoogwaardige PDF’s maakt.

Samenvatting

1. De DocuGenerate Snippet Toevoegen
2. De Functies Gebruiken om Logica te Bouwen
3. Document Genereren (Function)
4. Documenten Weergeven (Function)
5. Document Ophalen (Function)
6. Document Bijwerken (Function)
7. Document Verwijderen (Function)
8. Sjabloon Maken (Function)
9. Sjablonen Weergeven (Function)
10. Sjabloon Ophalen (Function)
11. Sjabloon Bijwerken (Function)
12. Sjabloon Verwijderen (Function)

1. De DocuGenerate Snippet Toevoegen

Voeg om te beginnen de DocuGenerate-snippet toe aan uw Xano-account en configureer deze met uw API-sleutel. Wij gebruiken Xano-omgevingsvariabelen om uw API-sleutel veilig op te slaan.

Ga naar uw accountinstellingen van DocuGenerate om uw API-sleutel te verkrijgen, en voer deze in bij de Xano-werkruimte-instellingen als waarde voor de omgevingsvariabele docugenerate_api_key.

De DocuGenerate API-sleutel configureren in Xano

2. De Functies Gebruiken om Logica te Bouwen

Zodra de snippet is toegevoegd aan uw werkruimte, kunt u de aangepaste functies van DocuGenerate gebruiken om de logica voor uw backend-workflows te bouwen.

  • Navigeer naar de Function Stack en klik op de knop Add function.
  • Vouw de categorie Custom Functions uit en selecteer een van de functies van DocuGenerate.
  • Configureer de functie door de vereiste parameters op te geven.
  • Combineer deze functies met andere Xano-logica om dynamische workflows te creëren.

De aangepaste functie van DocuGenerate toevoegen aan de Function Stack

Hiermee kunt u de exacte logica definiëren voor het maken, bijwerken of beheren van sjablonen en documenten binnen uw applicatie.

3. Document Genereren (Function)

Deze functie 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 invoer is aanpasbaar:

  • template_id (Sjabloon-ID): Verplicht om aan te geven welk sjabloon moet worden gebruikt.
  • name (Tekst): Optioneel; ken een naam toe aan het gegenereerde document.
  • output_name (Tekst): Optioneel; definieer een aangepaste bestandsnaam voor het uitvoerdocument.
  • output_format (Tekst): Optioneel; geef het uitvoerformaat op (bijv. .pdf, .docx, .doc, .odt, .txt, .html, .png).
  • data (JSON): Verplicht; data om velden in het sjabloon in te vullen.

Function om een document te genereren

4. Documenten Weergeven (Function)

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 invoer:

  • template_id (Sjabloon-ID): Verplicht om aan te geven voor welk sjabloon documenten moeten worden weergegeven.

Function om documenten weer te geven

5. Document Ophalen (Function)

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

  • id (Document-ID): Verplicht om aan te geven welk document moet worden opgehaald.

Function om een document op te halen

6. Document Bijwerken (Function)

Gebruik deze functie om details van een bestaand document te wijzigen, zoals het bijwerken van de naam van het document. De volgende invoer wordt verwacht:

  • id (Document-ID): Verplicht om aan te geven welk document moet worden bijgewerkt.
  • name (Tekst): Optioneel; wijzig de naam van het document.

Function om een document bij te werken

7. Document Verwijderen (Function)

Deze functie verwijdert een document uit uw DocuGenerate-account. Het vereist de volgende invoer:

  • id (Document-ID): Verplicht om aan te geven welk document moet worden verwijderd.

Function om een document te verwijderen

8. Sjabloon Maken (Function)

Upload een nieuw bestand als sjabloon naar uw DocuGenerate-account. Met deze actie kunt u ook een optionele naam opgeven voor het sjabloon. Eenmaal geüpload, kan dit sjabloon worden gebruikt om documenten te genereren op basis van gebruikersdata. De volgende invoer wordt verwacht:

  • file (Bestandsupload): Verplicht; upload het .docx-bestand dat als sjabloon moet worden gebruikt.
  • name (Tekst): Optioneel; geef een naam op voor het nieuwe sjabloon.

Function om een sjabloon te maken

9. Sjablonen Weergeven (Function)

Gebruik deze aanroep om een lijst op te halen van alle sjablonen die zijn opgeslagen in uw DocuGenerate-account, inclusief basisgegevens zoals sjabloonnamen en ID’s.

Function om sjablonen weer te geven

10. Sjabloon Ophalen (Function)

Deze aanroep 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. Deze aanroep vereist de volgende invoer:

  • id (Sjabloon-ID): Verplicht om aan te geven welk sjabloon moet worden opgehaald.

Function om een sjabloon op te halen

11. Sjabloon Bijwerken (Function)

Wijzig het bestand van een bestaand sjabloon of werk de naam ervan bij. De volgende invoer is vereist:

  • id (Sjabloon-ID): Verplicht om aan te geven welk sjabloon moet worden bijgewerkt.
  • file (Bestandsupload): Optioneel; upload een nieuw bestand als u de sjabloon-inhoud bijwerkt.
  • name (Tekst): Optioneel; werk de sjabloonnaam bij.

Function om een sjabloon bij te werken

12. Sjabloon Verwijderen (Function)

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

  • id (Sjabloon-ID): Verplicht om aan te geven welk sjabloon moet worden verwijderd.

Function om een sjabloon te verwijderen