Ändern Sie die DocuSign-API-Version

Standardmäßig sendet die DocuSign-Spoke REST-API-Anforderungen an die DocuSign-API v2. Aus Gründen der Vorwärtskompatibilität und um die neuere API von DocuSign zu nutzen, können Sie ein Verbindungsattribut aktualisieren, um API-Anforderungen an die DocuSign-API v2.1 zu senden.

Vorbereitungen

Erforderliche Rolle: admin

Warum und wann dieser Vorgang ausgeführt wird

Informationen zum Unterschied zwischen den beiden APIs finden Sie auf der DocuSign-Entwicklerwebsite.

Prozedur

1. Navigieren zu Alle > DocuSign > Verbindungsaliasnamen.
2. Öffnen Sie den Verbindungsalias, für den Sie die Version aktualisieren möchten.
   Nur Anforderungen, die mit diesem Alias gesendet werden, verwenden die neue API-Version. Wenn Sie beispielsweise die API-Version für alle Anforderungen aktualisieren möchten und Ihre Implementierung mehrere Verbindungsaliase verwendet, müssen Sie jeden Verbindungsalias aktualisieren.
3. Fügen Sie in der zugehörigen Liste „Verbindungsattribute “ den API-Versionsdatensatz hinzu, oder bearbeiten Sie ihn.

   Feld	Wert
   Typ	Zeichenfolge
   Bezeichnung	API-Version
   Spaltenname	api_version
   Standardwert	v2.1

4. Speichern Sie den Datensatz, oder senden Sie ihn ab.

Ergebnisse

Wenn die DocuSign-Spoke eine API-Anforderung sendet, wird die API-Version verwendet, die im Standardwertfeld des Verbindungsattributs angegeben ist.