![postman logo](https://images.ctfassets.net/9pvazpst9iwl/1j7O6V4mex86T6dJhln2Ab/05e93bfa87027b0265a3983d813f20cb/postman.png?fm=avif&q=90&w=500)
新しいAPI ExplorerでDocusign eSignature APIを試す方法
API Explorerによって、Webから簡単にDocusign eSignature APIをテストすることができます。本記事では、新しくなったAPI ExplorerでDocusign eSignature API Envelopes: createメソッドを使って、エンベロープを作成して送信する例を紹介します。
![ja-JP](https://images.ctfassets.net/9pvazpst9iwl/7nteaNEbjLjUXPCVWlYC7U/4d89dd06bc653cea31a20dd8dcdc9d04/Engineer_20at_20work.jpeg?fm=avif&q=90&w=500)
API Explorerを使うことでWebから簡単にDocusign eSignature APIをテストすることができますが、この度、API ExplorerがAPIリファレンスと統合されて新しくなりました。
本記事では、新しいAPI ExplorerでDocusign eSignature API Envelopes: createメソッドを使って、もっとも単純なエンベロープを作成して送信する例をステップバイステップで紹介します。
まずは、以下のDocusign DeveloperサイトからEnvelopes: createのページを開きます。
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/
eSignature APIへの呼び出しを実行するには、有効なOAuthアクセストークンが必要ですが、API ExplorerをテストするにはLog Inを押してデベロッパーサンドボックスにログインすればOKです。
API Referenceが表示されているところから、[API Explorer] をクリックするとAPI Explorerが利用できます。
![New API Explore](https://images.ctfassets.net/9pvazpst9iwl/6984289828503208/1fd4ad7c8d748ee8faaf4231802f4bd0/New_API_Explore.jpg?fm=avif&q=90&w=500)
このAPI Explorerの画面から必要なパラメーターを入力していきます。
最初にParametersのaccountIDでアカウントIDを選択します。
エンベロープをAPIで作成するには、APIのリクエストボディにJSON構造を構築します。これには最低4つのパラメーター、ドキュメント、メール件名、受信者、ステータスが必要です。ここではこの4つのパラメーターと一つの署名フィールドをエンベロープに追加してみます。
Bodyから以下のようにパラメータを入力します。
ドキュメント
documentsの下の [+Add document 1] をクリックします。
![New API Explore (1)](https://images.ctfassets.net/9pvazpst9iwl/2640289529504737/89791fd582f2db9b853a609e61c3e6b3/New_API_Explore__1_.jpg?fm=avif&q=90&w=500)
document1の下のdocumentBase64の [Select file] をクリックしてファイルをアップロードします。
![New API Explore (2)](https://images.ctfassets.net/9pvazpst9iwl/7476680922065841/c36f65a9df16cbca2cf29bb197150778/New_API_Explore__2_.jpg?fm=avif&q=90&w=500)
以下のパラメータを入力します。
documentId:ここでは1を指定
fileExtention:PDFファイルの場合、pdfと指定
name:任意の名前を入力
メールの件名
emailSettings objectの下emailSubjectに任意のメール件名を入力します。
![New API Explore (3)](https://images.ctfassets.net/9pvazpst9iwl/732531216446598/eb477f15d63e5459ce36b10be4669ee3/New_API_Explore__3_.jpg?fm=avif&q=90&w=500)
受信者(と署名フィールド)
recipient objectの下矢印をクリックして受信者情報をいれます。
signers の [+Add signer 1] をクリックします。
![New API Explore (4)](https://images.ctfassets.net/9pvazpst9iwl/577606068345888/35c2e0c8fdae65f884d7ec26048502c9/New_API_Explore__4_.jpg?fm=avif&q=90&w=500)
以下の情報を入力します。
email:電子メール
name:名前
recipientId:ここでは1を指定
roleName:署名者の役割名を入れます
routingOrder:ここでは1を指定
加えて、tabsの下の矢印をクリックして署名フィールドの情報を入力します。
signerHereTabで [+Add signHere 1] をクリックします。
![New API Explore (5)](https://images.ctfassets.net/9pvazpst9iwl/4447779510084777/20db526fbf4e255fc3516114635195e3/New_API_Explore__5_.jpg?fm=avif&q=90&w=500)
以下の情報を入力します。
documentId:1
pagenumber:署名フィールドを置くドキュメントのページ番号
tablabel:署名フィールド名です。任意
xPosition:署名フィールドのX座標
yPosition:署名フィールドのY座標
ステータス
Statusにsentを入力します。
入力内容がJSON構造に反映されます。
![New API Explorer (6)](https://images.ctfassets.net/9pvazpst9iwl/4373047388979102/6cbe84f402a697453661a356c1351fce/New_API_Explorer__6_.png?fm=avif&q=90&w=500)
Downloadボタンを押すとJSONファイルがダウンロードできます。
![New API Explore (7)](https://images.ctfassets.net/9pvazpst9iwl/8912826535752965/ca603d658f6f873557b27d30af643713/New_API_Explore__7_.jpg?fm=avif&q=90&w=500)
最後に”Get Response”をクリックすると、POSTリクエストが送信されます。
![New API Explore (8)](https://images.ctfassets.net/9pvazpst9iwl/8449087286803087/30c73038e85e0db305e39552a38fa9d7/New_API_Explore__8_.jpg?fm=avif&q=90&w=500)
成功するとResponseに201 Createdと表示されます。実際に受信者がメールを受信していることを確認し、エンベロープを開くと、指定したドキュメントのページの座標に署名フィールドが配置されていることが確認できます。
![New API Explore (9)](https://images.ctfassets.net/9pvazpst9iwl/5408195136271229/faec5b2eee64244dfcde20ea5bdf9f3d/New_API_Explore__9_.jpg?fm=avif&q=90&w=500)
![New API Explore (10)](https://images.ctfassets.net/9pvazpst9iwl/6216295008444589/c563f6b349ce654087f83a07d95c13eb/New_API_Explore__10_.jpg?fm=avif&q=90&w=500)
以上ご紹介したように、API Explorerにより気軽にDocusign eSignatureのAPIを試すことができます。ぜひ、APIを理解するはじめの一歩としてご活用ください。また、今後は詳細なAPIの仕様機能確認にお役立ていただき、本格的な業務インテグレーションを実現していただければと思います。