Integration mit Backendless

Hilfe-Center

Backendless-Startseite

Backendless ermöglicht Ihnen die Integration mit DocuGenerate, um Ihrem Backend eine Dokumenterstellung hinzuzufügen. Durch die Kombination der Leistungsfähigkeit von Backendless mit den umfangreichen Funktionen von DocuGenerate können Sie Ihre Workflows automatisieren und Ihre Abläufe effizient skalieren.

Zusammenfassung

1. Den DocuGenerate API-Dienst Installieren
2. Dokument Generieren (Operation)
3. Dokumente Auflisten (Operation)
4. Dokument Abrufen (Operation)
5. Dokument Aktualisieren (Operation)
6. Dokument Löschen (Operation)
7. Vorlagen Auflisten (Operation)
8. Vorlage Abrufen (Operation)
9. Vorlage Löschen (Operation)

1. Den DocuGenerate API-Dienst Installieren

Gehen Sie zunächst zum Abschnitt API Services im Backendless Marketplace und suchen Sie den DocuGenerate-Dienst. Klicken Sie auf die Schaltfläche GET, um DocuGenerate in Ihrem Konto zu installieren, und folgen Sie den Anweisungen zur Konfiguration des Dienstes mit Ihrem API-Schlüssel.

DocuGenerate aus dem Marketplace installieren

Rufen Sie Ihre DocuGenerate-Kontoeinstellungen auf, um Ihren API-Schlüssel zu erhalten, und geben Sie ihn im Konfigurationsdialog als Wert für das Feld API Key ein.

DocuGenerate-API-Schlüssel in Backendless konfigurieren

2. Dokument Generieren (Operation)

Diese Operation 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 Parameter sind anpassbar:

  • Template ID: Gibt die zu verwendende Vorlage an.
  • Name: Name des generierten Dokuments.
  • Output Name: Dateiname des generierten Dokuments.
  • Output Format: Ausgabeformat (z. B. .pdf, .docx, .doc, .odt, .txt, .html, .png).
  • Data: JSON-Daten zum Befüllen der Felder in der Vorlage.

Operation „Dokument generieren"

3. Dokumente Auflisten (Operation)

Ruft eine Liste der aus einer bestimmten Vorlage generierten Dokumente ab, sodass Sie zuvor generierte Dokumente zu einer Vorlage verfolgen oder anzeigen können. Folgender Parameter ist erforderlich:

  • Template ID: Gibt die Vorlage an, für die Dokumente aufgelistet werden sollen.

Operation „Dokumente auflisten"

4. Dokument Abrufen (Operation)

Diese Operation ruft Metadaten für ein bestimmtes Dokument ab, z. B. Dateiname, Format und Dokument-URI. Folgender Parameter ist erforderlich:

  • id: Gibt die ID des abzurufenden Dokuments an.

Operation „Dokument abrufen"

5. Dokument Aktualisieren (Operation)

Verwenden Sie diese Operation, um Details eines vorhandenen Dokuments zu ändern, z. B. den Namen des Dokuments. Folgende Parameter werden erwartet:

  • id: Gibt die ID des zu aktualisierenden Dokuments an.
  • Name: Aktualisierter Name des Dokuments.

Operation „Dokument aktualisieren"

6. Dokument Löschen (Operation)

Diese Operation löscht ein Dokument aus Ihrem DocuGenerate-Konto. Folgender Parameter ist erforderlich:

  • id: Gibt die ID des zu löschenden Dokuments an.

Operation „Dokument löschen"

7. Vorlagen Auflisten (Operation)

Ruft eine Liste aller in Ihrem DocuGenerate-Konto gespeicherten Vorlagen ab, einschließlich grundlegender Details wie Vorlagennamen und -IDs. Diese Operation erfordert keine Parameter.

Operation „Vorlagen auflisten"

8. Vorlage Abrufen (Operation)

Diese Operation ruft detaillierte Informationen zu einer bestimmten Vorlage anhand ihrer eindeutigen ID ab. Sie können Attribute wie Name, Tags und Format der Vorlage aufrufen. Folgender Parameter ist erforderlich:

  • id: Gibt die ID der abzurufenden Vorlage an.

Operation „Vorlage abrufen"

9. Vorlage Löschen (Operation)

Entfernen Sie eine Vorlage aus Ihrem DocuGenerate-Konto. Folgender Parameter ist erforderlich:

  • id: Gibt die ID der zu löschenden Vorlage an.

Operation „Vorlage löschen"