API Frequently Asked Questions

Dieser Artikel fasst einige der am häufigsten gestellten Fragen zur Xodo Sign API zusammen und beantwortet sie. Wenn Sie Ihre Antwort hier nicht finden können, sehen Sie sich bitte auch andere Artikel an, die hier im Entwicklerbereich verfügbar sind.

Q: Gibt es einen Sandbox (Test) Modus?

A: Ja, Sie können den Sandbox-Modus mit allen Konten unbegrenzt nutzen 👉 Sandbox-Modus.
Um ein Testdokument zu senden, müssen Sie den folgenden Parameter in Ihrer API-Anfrage festlegen:

"sandbox": 1,
Q: Wie kann ich meinen API Schlüssel resetten? 

A: Um Ihren API-Zugriffsschlüssel zurückzusetzen, navigieren Sie einfach zum Dropdown-Menü oben links und wählen Sie die Registerkarte Developer. Sobald Sie auf das API Dashboard zugreifen, sehen Sie die Schaltfläche „Reset Access Key“. Wenn Sie darauf klicken, führen Sie die Aktion zum Zurücksetzen aus, woraufhin Sie eine Bestätigung erhalten.

Weitere Informationen zu Ihrem Zugriffsschlüssel finden Sie unter folgendem Link 👉API-Zugriffsschlüssel

API Access Key

Q: Wie setze ich Embedded Signing auf?

A: Sie müssen den folgenden Parameter in Ihrer POST-Anforderung festlegen:

"embedded_signing_enabled": 1,

Dadurch wird eine „embedded_signing_url“ zurückgegeben, die dann an Ihren iFrame übergeben werden kann: https://eversign.com/api/documentation/embedded-signing#server-side

Q: Wie verwende ich ein über die Benutzeroberfläche erstelltes Dokument zum Embedded Signing Prozess?

A: Über die Benutzeroberfläche von Xodo Sign können Sie kein Dokument in Ihre Website einbetten. Sie können jedoch die Benutzeroberfläche verwenden, um das Dokument zu erstellen, und dann einen GET-Dokument-API-Aufruf verwenden, um den richtigen Text für Ihre neue Dokumentanforderung abzurufen.

Q: Gibt es eine Möglichkeit, eine Signatur über die API vorab auszufüllen?

A: Sie können eine Signatur nicht über die API vorab ausfüllen, da es nicht möglich wäre, die Herkunft der Signatur zu validieren und die Unterschriftsabsicht zu bestätigen, was ein wesentlicher Bestandteil einer rechtsverbindlichen Signatur ist.

Q: Was bedeutet die Nachricht "E-Mail Validation waived by account owner” am Ende eines Dokuments?

A: Diese Nachricht wird angezeigt, weil im Zap eine aktivierte Einstellung „embedded_signing_enabled“ vorhanden ist. Sie müssen diese Einstellung deaktivieren, wenn Sie nicht möchten, dass auf die E-Mail-Validierung verzichtet wird, aber das bedeutet auch, dass Sie die „embedded_signing_url“ nicht erhalten können.

Q: Kann ich Name und E-Mail Adresse des Senders verändern?

A: Ja, Sie können mit Ihrer POST-API-Anfrage die benutzerdefinierten Requester-Parameter ändern oder eine Variable an diese übergeben:

  "custom_requester_name": "",
  "custom_requester_email": "",
Q: Eingebettete Anfrage gibt embedded_claim_url nicht zurück?

A: Bitte stellen Sie sicher, dass Sie Folgendes eingestellt haben:

"is_draft": 1,
Q: Verbotene API-Client-ID beim Erstellen eines Dokuments?

A: Sie müssen sicherstellen, dass Sie den "client": "", sicheren Parameter festgelegt oder aus Ihrer API-Anfrage entfernt haben. Es kann nicht als „api_sandbox“ oder „eversign_portal“ festgelegt werden.

Q: Warum werden meine E-Mails nicht gesendet, wenn ich das flexible Signieren aktiviere?

A: Standardmäßig ist flexible_signing deaktiviert und E-Mails werden zugestellt. Wenn Sie flexible_signing = 1 aktivieren, werden standardmäßig keine E-Mails mehr versendet (deliver_email = 0). Die Lösung besteht darin, in Ihrem API-Aufruf für jeden Unterzeichner explizit delivery_email = 1 anzugeben.

Q: Was ist eine Vorlagen ID?

A: Die Vorlagen-ID ist mit dem Dokument-Hash der Vorlage identisch. Bei Verwendung einer Vorlage hat das erstellte Dokument einen eigenen Dokument-Hash, aber die Vorlagen-ID kann dann auf die ursprüngliche Vorlage zurückgeführt werden.

Q: Wie kann ich den Status eines Dokuments über die API überprüfen?

A: Es gibt zwei Methoden, mit denen Sie den Status eines Dokuments über die API überprüfen können. 

  1. Sie können Webhooks in Ihren Workflow einführen. Diese geben Ihnen aktuelle Ereignisse in Bezug auf Ihren document_hash - https://eversign.com/api/documentation/webhooks#account-callbacks
  2. Sie können eine GET-Dokumentanforderung mit document_hash verwenden und den Status aus dem Antworttext abrufen- https://eversign.com/api/documentation/methods#get-document-template
Q: Warum platzieren meine versteckten Tags (Hidden Tags) keine Felder in der PDF-Datei?

A: Sie müssen sicherstellen, dass Sie versteckte Tags (Hidden Tags) in Ihren Unternehmenseinstellungen > Allgemeine Einstellungen aktiviert haben

Q: Was passiert, wenn ich das monatliche Limit meiner API-Anfragen erreiche, gibt es Kontingentüberschreitungsmöglichkeiten?

A: Falls Sie Ihr API Limit erreichen und vor Ende des Monats noch weitere Anforderungen benötigen, können Sie einfach zusätzliche Kosten für Ihr Konto ermöglichen. Eine Überschussrechnung wird separat zu Beginn eines neuen Monats erstellt.

Q: Ist es möglich, die ungenutzten API Anfragen auf den nächsten Monat zu übertragen?

A: Nein, es ist nicht möglich, die ungenutzten API Anfragen zu übertragen. Der Kontingentzähler wird jeden Monat zurückgesetzt.

Q: Sind mit Xodo Sign API signierte Dokumente rechtsverbindlich?

A: Ja. Über die Xodo Sign API gesendete und signierte Dokumente sind rechtsverbindlich.
Weitere Informationen zur Legalität von elektronischen Signaturen finden Sie im folgenden Artikel 👉
Is Xodo Sign Legally Binding?

War dieser Beitrag hilfreich?
6 von 7 fanden dies hilfreich