Workflow API
Einführung
Was ist die Workflow API?
Erste Schritte
Test API Workflow
Bevor Sie Änderungen an Ihrem System vornehmen, ist es ratsam, die Funktionalität unseres API-Workflows in einer kontrollierten Umgebung zu testen. Hier erfahren Sie, wie Sie dies mit Postman tun können:
Schritt 1: Testumgebung vorbereiten: Richten Sie in Postman eine Testumgebung ein, die die Konfiguration und die Parameter Ihres Systems nachahmt. Dazu gehört die Konfiguration von Variablen für Workflow-Details, Dateidaten, Unterzeichnerinformationen usw.
Schritt 2: Importieren Sie die API-Dokumentation: Importieren Sie unsere Workflow-API-Dokumentation in Postman, um auf die verfügbaren Endpunkte und Anforderungsmethoden zuzugreifen. Diese Dokumentation enthält Einzelheiten zur Strukturierung Ihrer Anfragen und zur Behandlung von Antworten.
Schritt 3: Überprüfen Sie die Ergebnisse: Überprüfen Sie die Antworten der einzelnen Anfragen, um sicherzustellen, dass sie Ihren Erwartungen entsprechen und keine Fehler oder Unstimmigkeiten auftreten.
Verwenden Sie die Testfunktionen von Postman, um den Überprüfungsprozess zu automatisieren und die erwarteten Ergebnisse mit den tatsächlichen Ergebnissen abzugleichen.
Implementierung
- Geben Sie Details zur Workflow-Konfiguration wie Name, Beschreibung und Webhook-Konfiguration ein, um den Workflow-Einrichtungsprozess zu starten.
- Nach dem Hinzufügen des Workflows generiert unsere Datenbank eine eindeutige Workflow-ID und sendet sie an Sie zurück.
- Konfigurieren Sie die Dateidaten einschließlich Name, Typ, XFDF (XML Forms Data Format) und base64-Kodierung.
- Verwenden Sie die empfangene Workflow-ID, um die Datei mit dem entsprechenden Workflow zu verknüpfen.
- Konvertieren Sie PDF-Dateien in das XFDF-Format für eine nahtlose Integration. Weitere Informationen über den Konvertierungsprozess finden Sie hier: (Link hinzufügen)
- Nach erfolgreicher Übermittlung erhalten Sie eine Datei-ID zur Identifizierung und Verwaltung der hochgeladenen Datei innerhalb des Workflows.
AddSigner (POST) - Unterzeichnerkonfiguration bereitstellen:
- Konfigurieren Sie Unterzeichnerdetails wie Unterschriftstyp, Telefonnummer, Name, E-Mail usw. für den angegebenen Workflow.
- Verwenden Sie die Workflow-ID, um Unterzeichner mit dem jeweiligen Workflow zu verknüpfen.
- Verwenden Sie die Funktion "addSigner", um Unterzeichner nahtlos zum Workflow hinzuzufügen.
AddSignatur (POST) - Unterschriftsdaten bereitstellen:
- Übermitteln Sie Unterschriftsdaten, einschließlich der Datei-ID, XFDF, Position, Seite und Unterzeichner-ID, um den Unterzeichnungsprozess zu initiieren.
- Verwenden Sie die Funktion "Signatur hinzufügen" (HTTP PUT-Methode), um Signaturen an die angegebene Datei innerhalb des Workflows anzuhängen.
- Stellen Sie sicher, dass alle erforderlichen Parameter korrekt angegeben werden, um eine reibungslose Platzierung der Signatur zu ermöglichen.
- Fügen Sie optional relevante Anmerkungen oder Kommentare hinzu, um zusätzlichen Kontext oder Anweisungen innerhalb des zu signierenden Dokuments zu liefern.
- AddInterface (POST) - Anpassen der Schnittstelleneinstellungen: (Optional)
- Passen Sie die Schnittstelleneinstellungen an, indem Sie das Logo und die Farben Ihres Unternehmens einbinden, um die Markenkonsistenz zu wahren und die Benutzerfreundlichkeit zu verbessern.
Name | Default value | Mandatory | |
|---|---|---|---|
[PK] Interface ID | interface_id | public.gen_random_uuid() | Yes |
organization_id | organization_id | - | Yes |
Primary color | primary_color | DEFAULT_SIGN8_COLOR | Yes |
Icon | icon_file_id | DEFAULT_SIGN8_ICON_FILE_ID | Yes |
Logo | icon_file_id | DEFAULT_SIGN8_LOGO_FILE_ID | Yes |
Create timestamp | created_at | CURRENT_TIMESTAMP | Yes |
Update timestamp | updated_at | CURRENT_TIMESTAMP | Yes |
[PK] Primary key
Unterschriftslink einrichten:
Konfigurieren Sie Unterschriftslinks, die per E-Mail oder über andere Kommunikationskanäle versendet werden, um Unterzeichner zum Zugriff auf den Workflow und zum Abschluss desselben einzuladen.
Stellen Sie den Unterzeichnern direkte Links zum Workflow zur Verfügung, um einen nahtlosen Zugriff auf den Unterzeichnungsprozess zu gewährleisten.
Wenn Sie diese Schritte befolgen, können Sie unsere Workflow-API nahtlos in Ihr System integrieren und so eine effiziente Workflow-Verwaltung und elektronische Unterschriftsprozesse ermöglichen.
Use Cases
Webhook für abgelehnten Workflow
· Webhook URL: {{webhook_url}}/api/workflow/workflowRefused
· Method: POST
· Headers:
§ organization_id: {{organization_id}}
- created_by: {{user_id}}
- webhookPassword: {{webhook_password}}
Wenn ein Workflow abgelehnt wird, löst die Workflow-API diesen Webhook aus und sendet eine POST-Anfrage an die angegebene URL. Ihr System kann dann das Ablehnungsereignis entsprechend behandeln, z. B. die relevanten Beteiligten benachrichtigen oder den Workflow-Status aktualisieren.
Webhook für Workflow ist abgelaufen
Auf ähnliche Weise können Sie einen Webhook konfigurieren, um Benachrichtigungen zu erhalten, wenn ein Workflow abgelaufen ist. Auf diese Weise kann Ihr System als Reaktion auf abgelaufene Arbeitsabläufe die erforderlichen Maßnahmen ergreifen.
- Webhook URL: {{webhook_url}}/api/workflow/workflowExpired
- Method: POST
- Headers:
- organization_id: {{organization_id}}
- created_by: {{user_id}}
- webhookPassword: {{webhook_password}}
Diese Anwendungsfälle zeigen, wie Sie mit Webhooks die Funktionalität der Workflow-API erweitern können, indem Sie Echtzeit-Benachrichtigungen und automatische Antworten auf bestimmte Workflow-Ereignisse ermöglichen. Durch die Integration dieser Webhooks in Ihr System können Sie das Workflow-Management rationalisieren und die Benutzerfreundlichkeit verbessern.
Sie benötigen weitere Unterstützung?
Related Articles
CSC API
Einführung Willkommen bei der CSC API von SIGN8! Dieser Leitfaden soll Ihnen helfen, unsere CSC API nahtlos in Ihr System zu integrieren. Die CSC API kann verwendet werden, um digitale Signaturen auf Dokumenten und Daten zu erstellen. Sie folgt den ...Integration für Ihr System
Hier finden Sie umfassende Informationen zu unseren API-Lösungen für digitale Signaturen. Als führender Anbieter bieten wir zwei Arten von APIs an, die Ihnen eine nahtlose Integration und effiziente Arbeitsabläufe ermöglichen: Workflow API Die ...Dokument signieren lassen
Mit SIGN8 können Sie Ihre Dokumente schnell und sicher zum Signieren an Dritte versenden. Als eIDAS-konformer Trust Service Provider bieten wir drei Arten von Signaturen an: Einfache Signatur (EEF) Einfachste E-Signaturform für Dokumente ohne ...Siegel beantragen, z.B. für EPREL
Als zertifizierter Trust Service Provider bieten wir neben elektronischen Signaturen auch qualifizierte und fortgeschrittene Siegel an. In diesem Tutorial haben den Siegelprozess Schritt für Schritt für Sie abgebildet. Alternativ haben wir die ...