API ExplorerでDocuSign eSignature APIを試す方法

コーディングするアジア人男性のエンジニア

API ExploreはWebから簡単にDocuSign eSignature APIをテストするためのツールです。APIのテストにはPostmanというツールもありますが、クライアント環境の準備なしに簡単に試すことができます。

※API Explorerは新しくAPI Referenceに統合されました。以下の手順はサポートされなくなりましたので、「新しいAPI ExplorerでDocuSign eSignature APIを試す方法」をご参照ください。

 

以下のURLからAPI Exploreにアクセスします。

https://apiexplorer.docusign.com/

まずSandbox環境での認証が求められます。開発者向けサンドボックスの作成はこちらをご覧ください。

Test DocuSign eSignature API with API Explore 1

AUTHENTICATE USING DEVELOPER ACCOUNTをクリックします。ここでは、OAuthのトークンを取得するか、すでに取得済みのトークンを貼り付けます。

Test DocuSign eSignature API with API Explore 2

GET OAUTH2 TOKENをクリックするとドキュサインの認証画面が表示されます。

Test DocuSign eSignature API with API Explore 3

ここで認証後に各APIをテスト可能です。認証トークン期限切れや再認証する場合はUnauthenticateをクリックして、再度認証してください。

Test DocuSign eSignature API with API Explore 4

左のペインからテストしたいAPIを選択します。

Test-DocuSign-eSignature-API-with-API-Explore-5

次にエンベロープを作成して送信する例をご紹介します。

左メニューからCreate Envelopeを選択します。

Test DocuSign eSignature API with API Explore 6

Sandbox環境のアカウントIDを確認してaccountIdに入力します。

Test DocuSign eSignature API with API Explore 7

envelopDefinitionの矢印をクリックして、documentsの矢印をクリックし “+document” をクリックします。documentBase64の [ファイルを選択] をクリックしてエンベロープに含めるドキュメントをアップロードします。

Test DocuSign eSignature API with API Explore 8

emailSubjectにメールのタイトルを入力します。さらにEnvelopeRecipientsの矢印、signersの矢印、”+signer”の順にクリックし、受信者の情報を入力します。clientUserIdはここでは何も入力しません。ここに値があると埋め込み署名になるため、メールが送信されません。emailにメールアドレス、nameに名前、recipientIdはここでは1、roleNameはここではSigner 1とし、routingOrderを1とします。

Test DocuSign eSignature API with API Explore 9

署名フィールド(タブ)を設定します。EnvelopeRecipientTabsの矢印、signHerTabsの矢印、”+signHere”の順にクリックします。ここで先ほどのdocumentIdを入力し、pageNumberに署名するドキュメントのページ番号、tabLabelに署名フィールドの名前、xPosition,yPositionに署名フィールドを配置するX座標、Y座標を指定します。

Test DocuSign eSignature API with API Explore 10

statusにsentを入力して、”SEND REQUEST”をクリックします。

Test DocuSign eSignature API with API Explore 11

以下リクエスト内容が表示されます。

Test DocuSign eSignature API with API Explore 12

成功するとResponseにSUCCESSと表示されます。

Test DocuSign eSignature API with API Explore 14

実際に受信者がメールを受信していることを確認し、エンベロープを開くと、指定したドキュメントのページの座標に署名フィールドが配置されていることが確認できます。

Test DocuSign eSignature API with API Explore 13

以上、ご紹介したようにAPI Exploreにより、特別なソフトや準備なしに、簡単にDocuSign eSignatureのAPIを試すことができ、またその仕組みや動きがご理解いただけたかと思います。本格的な開発に向けたはじめの一歩としてご活用ください。

 

Masao Ohkushi - Docusign Japan
筆者
Masao Ohkushi
Senior Sales Engineer
公開
関連トピック