PostmanによるDocuSign eSignature APIの呼び出し

Postman

PostmanはWeb APIの開発支援のためのクライアントツールで、グラフィカルユーザーインターフェイスを使用して、APIにPOSTまたはGETリクエストを行うことができます。 Postmanをインストールすると、事前に構築されたコレクションを環境にインポートしたり、コレクションをゼロから構築できます。以前のブログ「API ExploreでDocuSign eSignature APIを試す方法」ではAPI Exploreについてご紹介しましたが、Postmanを使えばDocuSign eSignature APIについてより詳細なテストを行うことができます。

DocuSign eSignature APIをPostmanで使う

コレクションを使用するには、最初にPostmanアプリをコンピューターにインストールする必要があります。 Linux、macOS、またはWindowsで使用できます。 インストールし、アプリケーションを直接起動して試すことができますが、DocuSignコレクションで使用するには、自身の環境の情報でアプリケーションを設定する必要があります。’

DocuSign用のPostman構成のセットアップ

DocuSign eSignature REST APIでPostmanを使用する前に、まずは構成を設定する必要があります。 構成は、DocuSign APIをインポートし、API資格情報を使用して環境を作成する1回限りのプロセスであるため、呼び出しを簡単に実行できます。 DocuSignコレクション用にPostmanを構成するには、次の手順に従ってください。

  1. DocuSign開発者アカウントとインテグレーションキーがあることを確認します。 お持ちでない場合は、無料でアカウントを作成できます。 
  2. DocuSign設定アプリケーション内の「アプリとキーページ」で新しいインテグレーションキー秘密鍵を作成します(秘密キーは作成時に1回しか表示されないため、メモしておいてください)。 また、このインテグレーションキーのリダイレクトURIリストに少なくとも1つのURLを追加する必要があります。 「http://localhost」のようなものを使用することをお勧めします。(詳細は後述)
  3. DocuSign eSignature API Postman Collectionのページに移動します。
  4.  [SET UP YOUR ENVIRONMENT] を選択します。 下記のダイアログボックスが表示され、上記の手順2で作成したインテグレーションキーと対応する秘密鍵を入力するように求められます。   Postman 0
  5. Environment(Demo)とAPIバージョン(v2.1)はデフォルト設定のままにします。
  6. CREATE ENVIRONMENT を選択します。
  7. eSignatureでRun in Postmanを選択します。
  8. 以下のようなポップアップウィンドウが表示されます。Postman for Windows(またはMac)を選択して、Postmanクライアントアプリケーションを実行します。   Postman
  9. Windowsではオプションです。もう一つのセキュリティポップアップでは、アプリケーションを起動する前に「Open Postman」の選択が必要な場合があります。
Postman (1)

Postmanを使用してDocuSign eSignature APIコールを作成する

前述の手順に沿って、PostmanでDocuSignを設定したら準備完了です。Postmanアプリで、Collectionsをクリックします。アプリは以下のように表示されます。

Postman (2)

認証コードの実行

先に進む前に、先ほど作成した環境情報がコール内の変数に適用されていることを確認するために、Postmanウィンドウの右上にある環境ドロップダウン(「目」のアイコンの左)からDocuSign-account-d(環境設定時にdemoを選択したので、本番では別の名前になります)を選択してください。

今回はAuthorization Code Grantを使用してアクセストークンを取得し、postmanからAPIコールを行う方法をご紹介します。JWT(JSON Web Tokens)を使用する場合もあります。

認証プロセスを開始するには、以下のようなURLを手動で構築する必要があります。

https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature&client_id={iKey}&redirect_uri={callback} 

{iKey}を先ほど作成した統合キーに置き換え、{callback}を設定したredirectUriに置き換えることを忘れないようご注意ください。ブラウザでこのURLを入力すると、開発者環境のDocuSignログイン画面が表示され、アカウントへの認証情報を入力することができます。このアプリケーションを初めて使用する場合は、以下に示す同意ダイアログが表示されます。新しく作成された統合キーを使用してアプリがDocuSignにAPIコールを行うことを許可するには、[同意する]を選択します。

Postman (3)

正しく設定されていれば、codeと呼ばれる追加のURLパラメータでリダイレクトURIにリダイレクトされます。

Postman (4)

このパラメータには、API呼び出しを行うためのアクセストークンを取得するために使用できる長いコードが含まれています。Postmanコレクションを開き、左側のDocuSign REST APIフォルダを展開します。次に、Authenticationフォルダを展開し、01 Authorize Code Grant Access Tokenを選択します。

このコードをコピーして Postman アプリケーションに貼り付けます。URLパラメータから取得したコードをコピーして、BodyKEY/VALUEのペアに貼り付けてください ({{codeFromUrl}}の値を置き換えてください)。コードの有効期限は2分間のみであることに注意してください。制限時間内にこの情報をDocuSignに送信しなかった場合は、再度新しいコードを取得する必要があります。Postmanの上部にあるSendボタンを押して、DocuSignへの呼び出しを行います。成功すれば、access_tokenrefresh_tokenが返ってくるはずです。これらは自動的にPostman環境に保存されます。

Postman (5)

次に行う必要がある呼び出しは、04 Get User Infoです。これはAuthenticationフォルダの最後の呼び出しで、アクセストークンを取得したらすぐに実行できます。この呼び出しは、eSignature APIの呼び出しに必要なaccount_iduser_idbase_urlなどの追加の環境変数を入力するために使用されます。Postmanで環境クイックルック(環境ドロップダウンの右にある「目」のアイコン)を選択すると、すべての環境変数を表示し、DocuSign eSignature APIコールを開始するために必要なものが揃っていることを確認することができます。

Postmanを使った初めてのDocuSign eSignature APIコールの作成

インポートしたDocuSign eSignature APIコレクションには、可能なすべてのパラメータを含むAPIコールの全セットが含まれています。本ブログですべてをカバーすることはできませんが、ここでは、簡単なAPIコールを使って新しいエンベロープを作成する方法をご紹介します。 そのためには、いくつかデータの準備が必要です。

スクロールダウンして、エンベロープのカテゴリ/フォルダを展開すると、エンベロープに関連する様々なAPIコールを見つけることができます。POSTでエンベロープを作成するを選択します。それを開いて、PostmanでBodyタブを選択すると、以下のような画面になります。

Postman (6)

ボディ全体を削除し、シンプルなJSONボディに置き換えて、一人の受信者と短い一つののドキュメントを持つエンベロープを作成します。そのJSONは次のようになります(「email@domain.com」をメールアドレスに置き換えてください)。

{
    "emailSubject": "Please sign this document set",
    "documents": [
        {
            "documentBase64": "dGVzdCBkb2M=",
            "name": "Lorem Ipsum",
            "fileExtension": "txt",
            "documentId": "1"
        }
    ],
    "recipients": {
        "signers": [
            {
                "email": "email@domain.com",
                "name": "Your Name",
                "recipientId": "1",
                "routingOrder": "1",
            }
        ]
    },
    "status": "sent"
}

これを実行する前に、もう一つ変更を加える必要があります。PostmanのヘッダタブでContent-Typeヘッダのチェックを外してください。この呼び出しにはデフォルトのContent-Typeが必要です。

Postman (7)

呼び出しが成功した場合は、GUIDの値であるenvelopeIdが返却されます。また、使用したメールアドレス宛にDocuSignから文書への署名を求めるメールが届きます。

これで完了です!簡単にDocuSign eSignautre APIでエンベロープを送信することができます。これをきっかけに、ぜひ他のDocuSign eSignature APIも検証してみてください。

 

※本ブログは「Please Mr. Postman」の抄訳で、日本向けに一部加筆修正しています。

Contributeur DocuSign
筆者
DocuSign
公開
関連トピック