DocuSign API のバージョンの変更

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む1読むのに数分

    • デフォルトでは、DocuSign スポークは REST API 要求を DocuSign API v2 に送信します。上位互換性のため、および DocuSign の新しい API を利用するために、接続属性を更新して API 要求を DocuSign API v2.1 に送信できます。

    始める前に

    必要なロール：admin

    このタスクについて

    2 つの API の違いを理解するには、DocuSign 開発者サイトを参照してください。

    手順

    1. 移動先 すべて > DocuSign > 接続エイリアス.
    2. バージョンを更新する接続エイリアスを開きます。
      このエイリアスを使用して送信された要求のみが新しい API バージョンを使用します。たとえば、すべての要求の API バージョンを更新する必要があり、実装で複数の接続エイリアスを使用する場合は、各接続エイリアスを更新する必要があります。
    3. [接続属性] 関連リストで、API バージョンレコードを追加または編集します。
      フィールド 値
      タイプ 文字列
      ラベル API バージョン
      列名 api_version
      デフォルト値 v2.1
    4. レコードを保存または送信します。

    タスクの結果

    DocuSign スポークが API 要求を行うと、接続属性 [デフォルト値] フィールドで指定された API バージョンが使用されます。