Dropbox Sign API ダッシュボード

ライブ モードとテスト モードの比較

アプリを起動する前に、テスト モードでリクエストをテストできます。 このテストにより、ワークフローが希望どおりに編成されているかどうかを判断し、本番稼働前に予期しない動作を管理できるようになります。

テスト モードで行われたリクエストを表示するには、ライブからテストへのトグルをクリックします。ライブ モードに戻すと、ライブ サイトのイベントを API ダッシュボードに表示できます。

インサイト

［インサイト］タブには、API データの概要が表示されます。 このメイン ハブから、API リクエスト、署名依頼のステータス、署名依頼の使用量をグラフに照合してすぐに確認できます。 ページ上部のプルダウンを使用して、このデータのタイムライン ビューをデータ タイプ、日付範囲、エラー ステータス（API エラー分布、エンドポイント、または HTTP ステータス）別にカスタマイズできます。 アプリやアカウントのアクティビティのログを確認することもできます。

さらに［インサイト］タブでは、容量制限の使用状況（残りの署名依頼数）および基本的なお支払い情報も確認できます。

署名依頼のステータス

［署名依頼のステータス］タブでは、ドキュメント ID、署名依頼のステータス、およびイベントの日時を確認できます。 このページの情報は、ページ上部のプルダウンを使用して日付と署名依頼のステータスでフィルタリングできます。

アプリのコールバック

［アプリ コールバック］タブは、ユーザー インターフェース（UI）のインタラクションの設定と監視に役立ち、埋め込み機能のエンゲージメントについて詳細な状況を把握できます。

アプリ コールバックは、特定のアプリに関連付けられたプログラム済みアクション（別名「イベント」）が発生するとトリガーされます。 このタブで照合された情報には、サイト内依頼のみが表示されます。

コールバックについて、また Dropbox API ダッシュボードでコールバックを設定する方法について詳しくはこちらをご覧ください。

アカウントのコールバック

［アカウント コールバック］タブは、ワークフローを合理化し、遅延時間を最小限に抑えるためにサーバー イベントを設定および監視するのに役立ちます。

アカウント コールバックは、アカウントに関連するイベントが発生すると、イベント ペイロードをアカウント コールバック URL に送信することで（つまりそのイベント内に含まれるデータ全体が生成されたとき ）、アプリにこれを通知します。プルダウン メニューをクリックすると、日付とイベント タイプでアカウントのコールバックをフィルタリングできます。

アカウントのコールバック URL は、アカウント API コールを使用するか、［設定］ページで手動で設定できます。

コールバックについて、また Dropbox API ダッシュボードでコールバックを設定する方法について詳しくはこちらをご覧ください。

API リクエスト

［API リクエスト］タブには、送信したリクエストの機能の概要が表示されるので、リクエスト エラーのすばやい検索と対処が可能です。

ページ上部のプルダウンを使用して、API リクエストを日付、HTTP ステータス、メソッド、エンドポイントでフィルタリングできます。

HTTP コードは、ブラウザとサーバー間のインタラクションのステータスを表します。 API ダッシュボードを使用すると、HTTP ステータス コードでリクエストをフィルタリングし、どのリクエストに注意が必要か、どのリクエストが意図したとおりに機能しているかを合理化できます。

HTTP ステータスを理解する方法：

• Informationalステータスは、サーバーがリクエストをまだ完了していないことを意味します（コード 100～199）。
• Successステータスは、サーバーのリクエストがエラーなしで完了したことを意味します（コード 200～299）。
• Redirectional ステータスは、リクエストが受信されたが、その後別の場所にリダイレクトされたことを示します（コード 300～399）。
• Client error ステータスは、ページにアクセスできなかったことを意味します。 これはウェブサイト側からのエラーであり、多くの場合、ページがサイト上に存在しないときに発生します（コード 400～499）。
• Server error エラー ステータスは、有効なリクエストが行われたが、サーバーが期待どおりにリクエストを完了できなかった場合に発生します（コード 500～599）。

また、メソッドによって署名依頼をフィルタリングすることもできます。

• GET はリソースを取得または読み取るために使用されます。
• POST は新しいリソースを作成するために使用されます。
• DELETE はリソース全体を削除するために使用されます。
• PUT はリソース全体を変更するために使用されます。
• PATCH はリソースの一部を変更するために使用されます。

エンドポイントでリクエストをフィルタリングするには：

1. このビューに必要な他のリクエスト パラメータ（日付、HTTP ステータス、メソッド）を作成します。
2. ［エンドポイント］をクリックします。
3. ［カスタム］をクリックします。
4. 該当するエンドポイントの横にあるボックスをクリックします。
5. ［適用］をクリックします。

エンドポイントのリストは、署名依頼の概要でご参照いただけます。

署名依頼の使用

署名依頼を使用すると、署名者の名前とメール アドレス、カスタム フィールド、メタデータ、応答データ、リクエスト作成時・完了時のタイムスタンプなど、リクエスト固有のデータを参照できます。 使用データは日付とクライアント ID でフィルタリングできます。

アプリとキー

［アプリとキー］タブは、［設定］ページにリダイレクトされます。ここで、接続されたアプリとAPIキーを表示および管理できます。

複数の API キーの作成と管理について詳しくはこちらをご覧ください。

CSV ダウンロード

CSV ダウンロード タブには、カスタム日付範囲内のアカウントの署名リクエスト履歴が表示されます。このリストを.csvファイルにエクスポートできます。

その手順は次のとおりです：

1. Dropbox Sign にログインします。
2. ［API］をクリックします。
3. ［API ダッシュボードを表示］をクリックします。
4. ［CSV ダウンロード］をクリックします。
5. エクスポートしたい日付範囲を入力します。
6. ［CSV をダウンロード］をクリックします。

利用を開始するには、Dropbox Sign API ダッシュボードにアクセスしてください。

関連リソース

• 利用可能な機能と API ダッシュボードの使用方法の詳細については、API ダッシュボード ガイドをご覧ください。
• Dropbox Sign API の設定と実行の詳細については、API クイックスタートをご覧ください。

ご不明な点や問題の報告については、こちらからリクエストを送信してください。