新しいAPI Explorerがご利用いただけるようになりました

この度、新しいAPI Explorerが皆さまにご利用いただけるようになりました。

オリジナルのAPI Explorerツールは、ブラウザからコアな電子署名APIの呼び出しを行うのに便利でしたが、他のAgreement Cloud APIの基本的なサポートはありませんでした。さらに、DocuSign Developer Centerの外に置かれていたため、ユーザーが使用中のドキュメントを読むためには、常にコンテキストを切り替えなければならないという問題がありました。

新しいAPI ExplorerとReferenceのドキュメントは、Developer Centerの中でサイドバイサイドで利用でき、同じルック＆フィールと機能を共有しています。これは、両者が常に同期していることを意味し、開発者はブラウザを使用して、APIリファレンスを持つAgreement Cloud製品（eSignature、Notary、Monitor、Click、ID Evidence、Admin、Roomなど）を試すことができます。このブログ記事では、eSignature REST APIを例に挙げて説明します。

API Explorerは、API Referenceから誰でもアクセスできます。このツールを表示し、APIのURLやペイロードを構築するために使用するには、ログインは必須ではありません。ただし、APIの呼び出しや結果のプレビューには、アクティブな開発者アカウントのセッションが必要です。API Explorerはデモ環境で呼び出しを行い、開発者アカウントの登録は無料ですぐに行えます。

REST APIリファレンスのすべてのメソッド・ページに、API ReferenceとAPI Explorerを切り替えるトグルが追加されました。下図は、Users:listリファレンス・ページの上部にあるトグルになります。

API Explorerに切り替えると、そのAPIのパラメーター入力画面が表示されます。ここでパラメータ名をクリックすると、その説明が以下のようなポップアップウィンドウに表示されます。

ページの右側にあるコピーアイコンをクリックすると、メソッドのエンドポイントURIのパスとクエリの部分がクリップボードにコピーされます。コピーされた値には、accountId や envelopeId などの動的な値が含まれる場合があります。

必須（REQUIRED）となっているパラメータがすべて提供されると、「Get Response」ボタンが有効になり、HTTPコールが可能になります。

緑色のステータスバーには、HTTPレスポンスコードが表示されています。レスポンスコードがエラーの場合は、バーが赤くなります。その下には、「Data」タブと「Headers」タブがあり、どちらの場合もレスポンス情報をコピーすることができます。また、ローレスポンスデータをダウンロードすることもできます。緑色のボタンの左にあるアイコンは、スティッキーセクションをビューポートの高さの50％まで拡大します。

新機能の中で特筆すべきは、ドキュメントのページナビゲーションをサポートする埋め込み型のPDFビューアーです。これは、レスポンスがPDFドキュメントを表している場合、自動的に有効になります。また、従来のAPI Explorerと同様に、画像のプレビューもサポートされています。その他のバイナリ形式の場合は、レスポンスのデータをローカルファイルにダウンロードすることができます。

リクエストボディを必要とするHTTPコール（POSTコールなど）には、リクエストボディセクション（下図の左下）があり、右パネルに表示される有効なJSONペイロードを構築するのに役立ちます。

ボディセクションには、各JSONプロパティタイプを認識するリクエストエディタが含まれています。プロパティタイプが配列の場合は、アイテムの追加や削除ができ、Base64テキストの場合は、ファイルのバイトをBase64フォーマットでエンコードするための優れたファイルピッカーが表示されます。エディタのフォームに入力すると、JSONのプレビューが更新されます。いつでも、JSONのテキストをコピーすることができます。

さらに、このエディタは、再帰的にネストされたオブジェクトをサポートしています。オブジェクトについての包括的なドキュメントが必要なときは、そのオブジェクトの名前をクリックすれば、これまでのように説明がポップアップ表示されます。しかし、オブジェクトである以上、その子プロパティのドキュメントも参照したいと思うかもしれません。

そのために、「View Schema（スキーマを見る）」というハイパーリンクを追加しました。このリンクをクリックすると、右側にポップアップが表示され、オブジェクトに関するすべての情報を読み取ったり、子プロパティのドキュメントにドリルダウンすることができます。ポップアップの上部には、APIリファレンスへのディープリンクも用意されているので、コンテキストスイッチングを好まれる方にはお勧めです。

今回の紹介はここまでですが、私たちは次世代のAPI Explorerに取り組んでおり、今年の残りの期間に段階的に機能をリリースしたいと考えています。API Explorerはほんの始まりに過ぎず、我々はユーザーエクスペリエンスを向上させ、REST APIの知識があるなしに関わらず、誰もがあらゆるDocuSign Agreement Cloudの製品を活用できるようにすることを目標としています。機能に関するご提案やフィードバックは、developers@docusign.com までお送りください。

 

_{※本ブログは「New API Explorer generally available」の抄訳になります。}