Ändern Sie die Docusign-API-Version

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Standardmäßig sendet die Docusign-Spoke REST API-Anforderungen an die Docusign-API v2. Aus Gründen der Aufwärtskompatibilität und zur Nutzung der neueren API von Docusign 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

    Um den Unterschied zwischen den beiden APIs zu verstehen, besuchen Sie die Docusign Developer Site.

    Prozedur

    1. Navigieren zu Alle > Docusign > Verbindungsaliase.
    2. Öffnen Sie den Verbindungsalias, für den Sie die Version aktualisieren möchten.
      Nur mit diesem Alias gesendete Anforderungen 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 Datensatz „ API-Version “ 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, verwendet sie die API-Version, die im Feld „ Standardwert “ des Verbindungsattributs angegeben ist.