2.2 コネクタを使用したアプリケーション作成の前提条件
アプリケーションの作成前に完了する必要のあるタスクについて学習します。
2.2.1 コネクタのインストール・パッケージのダウンロード
コネクタのインストール・パッケージは、Oracle Technology Network (OTN) Webサイトで入手できます。
2.2.2 DocuSignコネクタのターゲット・システム・ユーザー・アカウントの作成
ユーザーは、DocuSignに内部環境を構築するための開発者アカウントを作成しておく必要があります。アプリケーションでDocuSign APIをインストールしてリクエストを操作するために必要になるためです。
必ず、ユーザーに対する完全な権限と制御を持ち、ユーザーの権限を表示できる、管理者としてのアカウントを作成してください。
2.2.3 ターゲット・システムの構成
これは、アプリケーションの作成前にターゲット・システムで実行するタスクの概要です。
DocuSignコネクタのインストール前の作業では、ターゲット・システムで一連のタスクを実行します。
インストール前の作業には、次のタスクが含まれます。
2.2.4 ユーザー・レベル・トークンを生成するOAuthフロー
ユーザー・レベルのアクセス・トークンおよびリフレッシュ・トークンを生成するには、3つのステップを手動で完了する必要があります。これらの値は、認証のためのDocuSignコネクタ基本構成のcustomAuthHeaders
内に指定する必要があります。
次のステップは、認可コード付与をオプトインするユーザーが実行する必要があります:
インターネット・ブラウザでこれらのURLを渡してoauth APIを入力するか、Postmanを使用してトークンを生成する必要があります。
- 認可コードのリクエスト
注意:
開発者環境用のトークンURIは、https://account-d.docusign.com/oauth/token
です。- 例に示すように、ブラウザで次のURLを入力します:
例:
https://accountd.docusign.com/oauth/auth?response_type=code&scope=signature&client_id={iKey}&redirect_uri={callback}
{iKey}を統合キーに置き換え、{callback}をリダイレクトURIに置き換えます。前述のURLには、eSignature REST APIに必要な署名スコープが含まれています。
このURLによってDocuSign認証画面が開きます。
- DocuSign開発者アカウントの電子メール・アドレスとパスワードを入力し、リクエストされたスコープについて同意します。ブラウザは、URLに埋め込まれたコード・パラメータに対して返された長い文字列を含むリダイレクトURIにリダイレクトされます。
例
リクエスト:
https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature&client_id=7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f&&redirect_uri=http://example.com/callback/
レスポンス:
http://example.com/callback/?code=eyJ0eXAi.....81QFsje43QVZ_gw
- 例に示すように、ブラウザで次のURLを入力します:
-
ステップ1で生成されたコードを使用したリフレッシュ・トークンおよびアクセス・トークンの生成。
- アクセス・トークンをリクエストするには、認可コードを含むPOSTリクエストをDocuSign認証サービスに送信します。
- 「Authorization」の下のUsernameとしての統合キーの値およびPasswordとしての秘密キーの値を、Postmanで「Basic Auth」タイプのアクセス・トークン・リクエストに貼り付けます。
- また、アクセス・トークン・リクエストには、本文パラメータのセット(grant_typeおよびcode)も含まれます。
- キーを、値が<code>のコードとして更新します。
注意:
<code>は、ステップ1のコールバックから受け取った認可コードです。たとえば、code=eyJ0eXAi.....QFsje43QVZ_gw
です。 - 同様に、キーをgrant_type、値をauthorization_codeとして、さらに1つの本文パラメータを更新します。
- キーを、値が<code>のコードとして更新します。
- 「Authorize Code Grant Access Token」リクエストを実行して、アクセス・トークンおよびリフレッシュ・トークンを生成します。
- レスポンスで、access_token、token_type、refresh_tokenおよびexpires_inという要素が返されます。
- access_tokenおよびrefresh_tokenの値をコピーまたは保存します。
認可コード付与を使用してアクセス・トークンを取得する方法の詳細は、https://developers.docusign.com/platform/auth/authcode/authcode-get-token/を参照してください。
例
リクエスト:
curl --header "Authorization: Basic NWMyYjhkN.....FhODg2MQ==" --data "grant_type=authorization_code&code=eyJ0eXAi.....QFsje43QVZ_gw" --request POST https://account-d.docusign.com/oauth/token
レスポンス:
{ "access_token":"eyJ0eXAi......mX9f7k1g", "token_type":"Bearer", "refresh_token":"eyJ0eXAi......mruC5c3A", "expires_in":28800 }
表2-1 要素
要素 説明 access_token アクセス・トークンの値。このトークンは、すべてのDocuSign APIコールの認可ヘッダーで使用します。 token_type トークンのタイプ。アクセス・トークンの場合、この値はBearerです。 refresh_token ユーザーの同意を必要とせずに新しいアクセス・トークンを取得するために使用されるトークン。リフレッシュ・トークンの存続期間は、通常は約30日間です。 expires_in アクセス・トークンが期限切れになるまでの秒数。 grant_type authorization_codeを使用してアクセス・トークンの認可コードを交換するために使用される付与のタイプ。 - DocuSignコネクタ基本構成の値の指定。
access_tokenおよびrefresh_tokenの値を取得したら、これらの値をDocuSignコネクタ基本構成のcustomAuthHeadersに指定する必要があります。構成の詳細は、「DocuSignコネクタの構成」を参照してください。たとえば、
access_token="eyJ0eXAi......mX9f7k1g"","refresh_token=eyJ0eXAi......mruC5c3A "
です表2-2 要素
要素 説明 refresh_token 認証から受信される完全なリフレッシュ・トークンの値。