Workflow API

Workflow API

Einführung

Willkommen bei der Workflow-API von SIGN8! Dieser Leitfaden soll Ihnen helfen, unsere Workflow-API nahtlos in Ihr System zu integrieren. Die Workflow API bietet Kernfunktionalität für die Verwaltung von Workflows innerhalb von Drittsystemen und ermöglicht eine effiziente Handhabung von Schnittstellen, Dateien, Signaturen und Unterzeichnern.

Was ist die Workflow API?

Die Workflow-API bietet alle wesentlichen Workflow-Funktionen für die Integration mit Drittsystemen. Sie vereinfacht den Workflow-Management-Prozess und ermöglicht die reibungslose Integration und den Betrieb von SIGN8-Signatur-Workflows in Ihrem System.

Erste Schritte

Um auf unsere Workflow-API zugreifen zu können, müssen Sie einen Enterprise- oder volumenbasierten Abonnementplan erwerben. Führen Sie nach dem Kauf die folgenden Schritte aus:

Schritt 1: Beantragen Sie Integrationszugang: Kontaktieren Sie unser Team und teilen Sie ihm mit, dass Sie unsere Lösung in Ihr System integrieren möchten. Unsere Entwickler werden Ihnen den erforderlichen Zugang zur Verfügung stellen.

Schritt 2: Zugriff auf die Dokumentation: Navigieren Sie in Ihrer Webanwendung zum Abschnitt Verwaltung. Dort finden Sie die API-Schaltfläche; wenn Sie darauf klicken, erhalten Sie Zugriff auf die technische Dokumentation für Ihre Entwickler.

Schritt 3: Zugriff auf Systeme: Wenn Sie auf die Dokumentation zugreifen, erhalten Sie Zugriff auf das Produktivsystem und das Testsystem. So können Sie Ihre Integration in einer kontrollierten Umgebung entwickeln und testen.

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

Um unseren API-Workflow in Ihr System zu implementieren, befolgen Sie diese ersten Schritte:

AddWorkflow (POST) - Workflow-Konfiguration bereitstellen:
  1. Geben Sie Details zur Workflow-Konfiguration wie Name, Beschreibung und Webhook-Konfiguration ein, um den Workflow-Einrichtungsprozess zu starten.
  2. Nach dem Hinzufügen des Workflows generiert unsere Datenbank eine eindeutige Workflow-ID und sendet sie an Sie zurück.
AddFile (POST) - Dateidaten bereitstellen:
  1. Konfigurieren Sie die Dateidaten einschließlich Name, Typ, XFDF (XML Forms Data Format) und base64-Kodierung.
  2. Verwenden Sie die empfangene Workflow-ID, um die Datei mit dem entsprechenden Workflow zu verknüpfen.
  3. Konvertieren Sie PDF-Dateien in das XFDF-Format für eine nahtlose Integration. Weitere Informationen über den Konvertierungsprozess finden Sie hier: (Link hinzufügen)
  4. Nach erfolgreicher Übermittlung erhalten Sie eine Datei-ID zur Identifizierung und Verwaltung der hochgeladenen Datei innerhalb des Workflows.

AddSigner (POST) - Unterzeichnerkonfiguration bereitstellen:

  1. Konfigurieren Sie Unterzeichnerdetails wie Unterschriftstyp, Telefonnummer, Name, E-Mail usw. für den angegebenen Workflow.
  2. Verwenden Sie die Workflow-ID, um Unterzeichner mit dem jeweiligen Workflow zu verknüpfen.
  3. Verwenden Sie die Funktion "addSigner", um Unterzeichner nahtlos zum Workflow hinzuzufügen.

AddSignatur (POST) - Unterschriftsdaten bereitstellen:

  1. Übermitteln Sie Unterschriftsdaten, einschließlich der Datei-ID, XFDF, Position, Seite und Unterzeichner-ID, um den Unterzeichnungsprozess zu initiieren.
  2. Verwenden Sie die Funktion "Signatur hinzufügen" (HTTP PUT-Methode), um Signaturen an die angegebene Datei innerhalb des Workflows anzuhängen.
  3. Stellen Sie sicher, dass alle erforderlichen Parameter korrekt angegeben werden, um eine reibungslose Platzierung der Signatur zu ermöglichen.
AddAnnotation (POST) - Zusätzliche Anmerkungen hinzufügen: (Optional)
  1. Fügen Sie optional relevante Anmerkungen oder Kommentare hinzu, um zusätzlichen Kontext oder Anweisungen innerhalb des zu signierenden Dokuments zu liefern.
  2. AddInterface (POST) - Anpassen der Schnittstelleneinstellungen: (Optional)
  3. 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

Technical identifier

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

In diesem Anwendungsfall können Sie einen Webhook einrichten, um Benachrichtigungen zu erhalten, wenn ein Workflow abgelehnt wurde. Dadurch kann Ihr System auf der Grundlage der Ablehnung eines Workflows entsprechende Maßnahmen ergreifen. 

·         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}}
Wenn ein Workflow sein Ablaufdatum erreicht, ruft die Workflow-API diesen Webhook auf, indem sie eine POST-Anfrage an die angegebene URL sendet. Ihr System kann dann das Ablaufereignis wie gewünscht behandeln, z. B. abgelaufene Workflows archivieren oder Benutzer benachrichtigen, um sie zu erneuern.

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 ...

      • API Changelog

        September 2024 New Features Breaking Changes Zeitpunkt der Signatur (Datum) wird nun im Signaturbild der QES angezeigt. Bug Fixing August 2024 New Features Breaking Changes Bug Fixing Juli 2024 New Features Breaking Changes Bug Fixing Juni 2024 New ...