Xano ermöglicht Ihnen die Integration mit DocuGenerate, um Ihrem Backend eine Dokumenterstellung hinzuzufügen. Unser Snippet stellt benutzerdefinierte Funktionen für die Verwaltung von Vorlagen und die Generierung von Dokumenten bereit und hilft Ihnen, Workflows zu automatisieren und hochwertige PDFs mühelos zu erstellen.
Zusammenfassung
1. Das DocuGenerate-Snippet Hinzufügen
2. Funktionen zum Aufbau der Logik Verwenden
3. Dokument Generieren (Funktion)
4. Dokumente Auflisten (Funktion)
5. Dokument Abrufen (Funktion)
6. Dokument Aktualisieren (Funktion)
7. Dokument Löschen (Funktion)
8. Vorlage Erstellen (Funktion)
9. Vorlagen Auflisten (Funktion)
10. Vorlage Abrufen (Funktion)
11. Vorlage Aktualisieren (Funktion)
12. Vorlage Löschen (Funktion)
1. Das DocuGenerate-Snippet Hinzufügen
Fügen Sie zunächst das DocuGenerate-Snippet zu Ihrem Xano-Konto hinzu und konfigurieren Sie es mit Ihrem API-Schlüssel. Wir verwenden Xano-Umgebungsvariablen, um Ihren API-Schlüssel sicher zu speichern.
Rufen Sie Ihre DocuGenerate-Kontoeinstellungen auf, um Ihren API-Schlüssel zu erhalten, und geben Sie ihn in den Xano-Workspace-Einstellungen als Wert für die Umgebungsvariable docugenerate_api_key ein.
2. Funktionen zum Aufbau der Logik Verwenden
Sobald das Snippet zu Ihrem Workspace hinzugefügt wurde, können Sie die benutzerdefinierten Funktionen von DocuGenerate nutzen, um die Logik für Ihre Backend-Workflows aufzubauen.
- Navigieren Sie zum Function Stack und klicken Sie auf die Schaltfläche Add function.
- Erweitern Sie die Kategorie Custom Functions und wählen Sie eine der DocuGenerate-Funktionen aus.
- Konfigurieren Sie die Funktion, indem Sie die erforderlichen Parameter übergeben.
- Kombinieren Sie diese Funktionen mit anderer Xano-Logik, um dynamische Workflows zu erstellen.
So können Sie die genaue Logik für das Erstellen, Aktualisieren oder Verwalten von Vorlagen und Dokumenten in Ihrer Anwendung definieren.
3. Dokument Generieren (Funktion)
Diese Funktion erstellt ein Dokument aus einer angegebenen Vorlage und einem Datensatz. Definieren Sie den Namen, Dateinamen und das Format des Dokuments und stellen Sie die Daten bereit, mit denen die Felder in der Vorlage befüllt werden. Die folgenden Eingaben sind anpassbar:
- template_id (Vorlagen-ID): Erforderlich, um die zu verwendende Vorlage anzugeben.
- name (Text): Optional; weisen Sie dem generierten Dokument einen Namen zu.
- output_name (Text): Optional; definieren Sie einen benutzerdefinierten Dateinamen für das Ausgabedokument.
- output_format (Text): Optional; geben Sie das Ausgabeformat an (z. B.
.pdf,.docx,.doc,.odt,.txt,.html,.png). - data (JSON): Erforderlich; Daten zum Befüllen der Felder in der Vorlage.
4. Dokumente Auflisten (Funktion)
Ruft eine Liste der aus einer bestimmten Vorlage generierten Dokumente ab, sodass Sie zuvor generierte Dokumente zu einer Vorlage verfolgen oder anzeigen können. Folgende Eingabe ist erforderlich:
- template_id (Vorlagen-ID): Erforderlich, um die Vorlage anzugeben, für die Dokumente aufgelistet werden sollen.
5. Dokument Abrufen (Funktion)
Diese Funktion ruft Metadaten für ein bestimmtes Dokument ab, z. B. Dateiname, Format und Dokument-URI. Folgende Eingabe ist erforderlich:
- id (Dokument-ID): Erforderlich, um anzugeben, welches Dokument abgerufen werden soll.
6. Dokument Aktualisieren (Funktion)
Verwenden Sie diese Funktion, um Details eines vorhandenen Dokuments zu ändern, z. B. den Namen des Dokuments. Folgende Eingaben werden erwartet:
- id (Dokument-ID): Erforderlich, um das zu aktualisierende Dokument anzugeben.
- name (Text): Optional; ändern Sie den Namen des Dokuments.
7. Dokument Löschen (Funktion)
Diese Funktion löscht ein Dokument aus Ihrem DocuGenerate-Konto. Folgende Eingabe ist erforderlich:
- id (Dokument-ID): Erforderlich, um das zu löschende Dokument anzugeben.
8. Vorlage Erstellen (Funktion)
Laden Sie eine neue Datei als Vorlage in Ihr DocuGenerate-Konto hoch. Diese Funktion ermöglicht auch die Angabe eines optionalen Namens für die Vorlage. Nach dem Hochladen kann diese Vorlage zur Dokumentgenerierung auf Basis von Benutzerdaten verwendet werden. Folgende Eingaben werden erwartet:
- file (Datei-Upload): Erforderlich; laden Sie die .docx-Datei hoch, die als Vorlage verwendet werden soll.
- name (Text): Optional; geben Sie einen Namen für die neue Vorlage an.
9. Vorlagen Auflisten (Funktion)
Verwenden Sie diesen Aufruf, um eine Liste aller in Ihrem DocuGenerate-Konto gespeicherten Vorlagen abzurufen, einschließlich grundlegender Details wie Vorlagennamen und -IDs.
10. Vorlage Abrufen (Funktion)
Dieser Aufruf ruft detaillierte Informationen zu einer bestimmten Vorlage anhand ihrer eindeutigen ID ab. Sie können Attribute wie Name, Tags und Format der Vorlage aufrufen. Folgende Eingabe ist erforderlich:
- id (Vorlagen-ID): Erforderlich, um anzugeben, welche Vorlage abgerufen werden soll.
11. Vorlage Aktualisieren (Funktion)
Ändern Sie die Datei einer vorhandenen Vorlage oder aktualisieren Sie ihren Namen. Folgende Eingaben sind erforderlich:
- id (Vorlagen-ID): Erforderlich, um die zu aktualisierende Vorlage anzugeben.
- file (Datei-Upload): Optional; laden Sie eine neue Datei hoch, wenn der Vorlageninhalt aktualisiert wird.
- name (Text): Optional; aktualisieren Sie den Vorlagennamen.
12. Vorlage Löschen (Funktion)
Entfernen Sie eine Vorlage aus Ihrem DocuGenerate-Konto. Folgende Eingabe ist erforderlich:
- id (Vorlagen-ID): Erforderlich, um die zu löschende Vorlage anzugeben.
