Zum Hauptinhalt springen

Iframe- oder eingebettete Signatur

Betten Sie die Signaturseite in Ihre eigene App ein/iframe ein.

Aktualisierung - JS-Komponentenbearbeitung und Signatur bald verfügbar. Kontaktieren Sie uns.

Wenn Sie eine einfache offene Seite benötigen, die keine Anpassung erfordert und auf der jeder ein Dokument unterschreiben kann (und optional anschließend seine E-Mail bestätigt), versuchen Sie Legalesign Link. Diese können Sie ohne Programmierung in der Web-App erstellen. Sie sind ebenfalls einbettbar. Beispiele für Links können Eventregistrierungen, Stundenzettel, Haftungsverzichtserklärungen sein. Erfahren Sie mehr über Legalesign Link (einbettbare Signaturseiten).

API

Wenn Sie das Dokument anpassen oder mehr Funktionalität benötigen, verwenden Sie die API.

Einschränkungen

Geräte

Dies bezieht sich auf PDF-basierte Dokumente (nicht auf text/html-basierte Dokumente).

  • Desktop-Kontexte funktionieren gut
  • Mobile Kontexte funktionieren für einfache Dokumente (z. B. eine Unterschrift, keine komplexen Formulare)
  • Mobile Kontexte mit komplexen Formularen funktionieren möglicherweise nicht gut (insbesondere bei iPhones), und wir empfehlen, den Benutzer in einem neuen Browserfenster zu öffnen (Sie können dies verbergen, indem Sie überflüssige Elemente der Signaturseite entfernen und eine Weiterleitung vornehmen, siehe unten).

Obwohl die letzte Option keine nahtlose Benutzererfahrung bietet, stellt sie eine zuverlässige Erfahrung für Ihre Benutzer sicher. Soweit wir wissen, ist es nicht möglich, die Größe des Geräts des Nutzers innerhalb eines iframe-Fensters (bei einigen oder allen iPhones) zuverlässig zu bestimmen, was eine saubere Navigation durch ein komplexes Formular unsicher macht.

Signaturstandard

Eine zweite Warnung: Ohne einige Planung werden Sie möglicherweise nicht den 'fortgeschrittenen' elektronischen Signaturstandard erfüllen.

Wichtige Grundsätze des Standards sind

  • Ihr Unterzeichner muss die alleinige Kontrolle über den Signaturvorgang haben und
  • er muss eindeutig identifizierbar sein.

Wenn Sie den Signaturlink selbst erhalten, können Sie das Dokument jetzt unterschreiben; die alleinige Kontrolle geht verloren.

Eine Lösung könnte sein, eine SMS-Validierung für Ihren Empfänger hinzuzufügen. Der Empfang dieser SMS wird unter der alleinigen Kontrolle Ihres Empfängers stehen und ihn eindeutig identifizieren.

Sie müssen planen, welche Kontrollen vorhanden sind, um sicherzustellen, dass der Unterzeichner identifizierbar ist und alleinige Kontrolle auf Ihrer Seite hat, um den 'fortgeschrittenen' Standard wieder zu erreichen. Erfahren Sie mehr über das Gesetz zu elektronischen Signaturen.

Sie haben das Quickstart-Tutorial durchlaufen und erfolgreich ein Dokument zum Signieren erstellt/versendet.

  1. Fügen Sie einfach folgendes Attribut zu Ihrer POST-Anfrage hinzu, die ein Dokument erstellt/versendet (z. B. /api/v1/document/):
{return_signer_links: true}
  1. Lesen Sie den BODY der Antwort und Sie finden ein JSON-Objekt mit den Signaturlinks für jeden Ihrer Dokumentempfänger.

  2. Betten Sie den Signaturlink in ein iframe-Element ein.

Weitere hilfreiche Attribute

  • Um alle Legalesign-E-Mails zu unterdrücken, setzen Sie im POST an /api/v1/document/ dieses Attribut: {do_email: false}.

  • Um den Benutzer unmittelbar nach der Signatur weiterzuleiten, fügen Sie das Attribut hinzu: {redirect: yourUrl } (siehe unten mehr).

  • Um überflüssige Elemente von der Signaturseite zu entfernen, fügen Sie diese Query-String-Parameter an den Signaturlink an: &hidenav=1&hidetext=1

Sehen Sie sich alle Attribute für den Send-Document-API-Aufruf hier an: Send Document API call

Safari-Faktor

Wenn Sie Safari-Nutzer erwarten, müssen Sie möglicherweise mit einem kleinen JavaScript-Snippet einen 'Fix' hinzufügen.

Die Standardeinstellungen von Safari erlauben keine iframe-Cookies. Wenn Sie dies ohne Nutzerstörung handhaben möchten, müssen Sie a) uns Ihre Root-Domain senden und b) vor dem Laden des iframes etwas JavaScript ausführen - hier geht es zum Code (Entschuldigung für das jQuery, Sie sollten es nach Bedarf anpassen können). Im JS müssen Sie Parameter zur abgefragten URL hinzufügen. Falls dies aus dem Codebeispiel nicht klar ist, kontaktieren Sie uns für Unterstützung.

Safari hat die Nutzung von iframes zunehmend erschwert.

Wenn Sie sicherstellen wollen, dass iframe in Safari funktioniert, müssen Sie unsere neue CNAME-Funktion verwenden. Damit werden die Signaturseiten in einer Subdomain Ihrer Hauptdomain platziert. Diese Funktion ist noch in der Beta-Phase, kontaktieren Sie uns, wenn Sie sie nutzen möchten.

Die beste Alternative ist, Benutzer in ein neues Browserfenster zu verlinken und eine Weiterleitung-nach-der-Signatur-URL auf das Dokument zu setzen, um sie nach Abschluss zurückzuholen (siehe unten).

Signale nach Abschluss

Es gibt zwei Möglichkeiten, die Kontrolle nach einer Signatur zu übernehmen.

  • Legen Sie beim Erstellen Ihres Dokuments eine Weiterleitungs-URL fest. Legalesign leitet den Benutzer nach Abschluss zum URL weiter, oder
  • verwenden Sie die JavaScript postMessage-Funktion.

Weiterleitungs-URL

Fügen Sie einfach die Weiterleitungs-URL als Attribut 'redirect' in die POST-Anfrage zum Erstellen des Dokuments (/api/v1/document/) ein.

Da die Umleitung dokumentenbezogen (nicht nutzerbezogen) ist, hängt Legalesign Ihrer Weiterleitungs-URL eine Abfragezeichenfolge an, die Sie nutzen können, um Informationen über den Dokument- und Unterzeichnerstatus zu sammeln:

[Ihre URL]?signer=[signer UID]&doc=[doc UID]&group=[group UID]&signer_state=[signer status]&doc_state=[doc state]

Klicken Sie auf diese Links, um die Referenztabellen für den Dokumentenstatus und den Unterzeichnerstatus zu sehen.

postMessage

Ein postMessage ist eine durch JavaScript gesendete Nachricht, die Sie in Ihrem übergeordneten Frame empfangen können. Sie können diese Nachrichten verwenden, um Weiterleitungen auszulösen oder die Seite bei Bedarf neu zu rendern.

Nach der Signatur erhalten Sie sofort eine von drei möglichen JavaScript postMessage-Nachrichten: 'waiting', 'signed', 'rejected'.

Wenn das Dokument unterschrieben wurde und Sie den Signaturvorgang fortsetzen und die Download-Seite in Ihrem iframe anzeigen lassen, erhalten Sie außerdem die Nachricht 'download', wenn der Dokument-Download-Button angeklickt wird.

Sie erhalten die Nachricht 'waiting', wenn mehr als ein Unterzeichner existiert und das Dokument noch weitere Unterschriften benötigt.

Weitere Informationen zu postMessage finden Sie unter: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage.

Wenn Sie den Unterzeichner weiterleiten möchten, beachten Sie, dass er oder sie möglicherweise kurz eine neu gerenderte Seite sieht (entweder die 'Download'-Seite oder die 'Warten auf andere'-Seite), bevor Ihre Weiterleitung mittels postMessage wirksam wird.

Nächstes.

Nach einer Signatur können Sie das finale PDF-Dokument herunterladen. Wir empfehlen dazu die Nutzung von Webhooks. Erfahren Sie mehr über Webhooks. Sehen Sie sich die Dokumentation des API-Aufrufs zum Herunterladen eines finalen PDFs an. Vermeiden Sie es, den Download unmittelbar nach einem Signaturereignis abzurufen (mithilfe der oben genannten post-signing Signale), da das finale PDF möglicherweise noch nicht bereitsteht. Zuverlässiger ist es, auf den Webhook zu hören, bei dem das Objekt 'document' und das Ereignis 'finalPdfCreated' lautet.