Überblick

Die Document Cloud-Dokument-API der eSign-Dienste wurde für die nahtlose Integration in Ihre bestehende Anwendung entwickelt, ohne dass Sie einen separaten von eSign-Diensten verwalteten Registrierungsprozess durchlaufen müssen. Daher muss die zugehörige Anwendung sicherstellen, dass der Absender ein registrierter eSign-Dienstbenutzer ist. Falls nicht, werden sie programmgesteuert durch die API registriert. Empfänger werden nie aufgefordert, sich zu registrieren, und alle auf Empfängerseite erforderlichen Interaktionen werden von den eSign-Diensten verwaltet.

Dokumentabsender angeben

Es gibt mehrere Möglichkeiten, einen Absender anzugeben, wenn Sie eine neue Transaktion mit der Methode sendDocument starten. Das Verhalten hängt davon ab, welche Werte über den optionalen Parameter SenderInfo übergeben werden.

  • Null-SenderInfo: In diesem Fall ist der Absender des Dokuments der spezielle eindeutige Benutzer, der mit dem verwendeten API-Schlüssel verknüpft ist. Diese Methode eignet sich für Testimplementierungen und bestimmte Implementierungen mit begrenztem Geltungsbereich, ist jedoch normalerweise nicht für umfangreiche Integrationen mit vorhandenen Benutzersätzen geeignet.
  • SenderInfo mit email und password: In diesem Fall ist der Absender des Dokuments der Benutzer, der im E-Mail-Parameter angegeben ist. Das angegebene Kennwort muss mit dem EchoSign-Kennwort des Benutzers übereinstimmen. Zur Integration können die E-Mail und das Kennwort im Kontext der übergeordneten Anwendung vom Benutzer angefordert werden, bevor das Dokument gesendet wird. Alternativ dazu kann die übergeordnete Anwendung die E-Mail und das Kennwort speichern, entweder weil die übergeordnete Anwendung den Benutzer erstellt hat oder weil der Benutzer diese Informationen zuvor angegeben hat und sie zwischengespeichert wurden.
  • SenderInfo mit email, aber ohne Kennwort: In diesem Fall ist der Absender des Dokuments der Benutzer, der im E-Mail-Parameter angegeben ist. Der Kennwortwert muss null sein. EchoSign prüft, ob der API-Aufrufer und der gewünschte Absender zum gleichen Konto gehören. Das Kennwort wird dabei aber nicht angefordert oder geprüft. Diese Methode eignet sich gelegentlich für API-Integrationen innerhalb eines bestimmten Unternehmens, bietet aber eine reduzierte individuelle Sicherheit. Dieses Authentifizierungsmodell muss explizit vom Masterkontoinhaber angefordert werden, um für die EchoSign-API verfügbar zu sein.

Kontoverwaltung der eSign-Dienste

Wie oben beschrieben geben Sie in den meisten Fällen die E-Mail-Adresse und das Kennwort des Benutzers an, in dessen Namen Sie das Dokument senden. Im folgenden Abschnitt werden die verschiedenen Methoden beschrieben, mit denen Informationen abgerufen werden können.

Benutzer auffordern

Fordern Sie den Benutzer auf, seine E-Mail-Adresse und sein Kennwort für eSign-Dienste beim Senden anzugeben. Sie können die Methode verifyUser verwenden, um zu prüfen, ob der Benutzer bei eSign-Diensten registriert ist und das Kennwort gültig ist. Wenn der Benutzer nicht registriert ist, können Sie ihn entweder auffordern, sein eigenes Konto für eSign-Dienste zu erstellen, oder ein Konto für ihn erstellen (siehe unten).

Konto erstellen

Wenn ein Aufruf von verifyUser ergibt, dass kein Benutzer mit dieser E-Mail-Adresse vorhanden ist, können Sie programmgesteuert einen eSign-Dienstbenutzer erstellen, indem Sie createUser aufrufen. Wenn die Benutzererstellung erfolgreich ist, können die angegebene E-Mail-Adresse und das angegebene Kennwort als SenderInfo für Ihr Dokument verwendet werden.

Konto speichern

Im Anschluss an die oben beschriebenen Szenarien können Sie die E-Mail-Adresse und das Kennwort des Benutzers speichern und als SenderInfo beim Senden nachfolgender Dokumente im Namen dieses Benutzers verwenden. Der Benutzer kann sich jederzeit bei Cloud eSign-Dienstkonto anmelden und sein Kennwort ändern. Die Anwendung muss daher damit umgehen können, wenn ein zuvor gespeichertes Kennwort ungültig ist.

Zusammenfassung

Es gibt verschiedene Möglichkeiten, die Absenderidentität zu ermitteln, wenn Sie die Dokument-API der eSign-Dienste verwenden. Lesen Sie die oben angegebenen Informationen sorgfältig durch, um zu entscheiden, welche Methode für Ihre Anwendung geeignet ist. Wenn Sie Fragen haben, können Sie sich jederzeit an uns wenden.

Dieses Werk unterliegt den Bedingungen der Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.  Twitter™- und Facebook-Beiträge fallen nicht unter die Bedingungen der Creative Commons-Lizenz.

Rechtliche Hinweise   |   Online-Datenschutzrichtlinie