新しいAPIダッシュボードのご紹介

概要•3分で読み終わります

リアルタイムのメトリクスを取得して、Docusign統合の健全性を監視

(本ブログは、2020年10月6日に公開された"The new API Dashboard is now available!"の抄訳版になります。)

Docusignプラットフォーム上のAPI統合の健全性を表示、分析、ダウンロード、監視するための新しいAPIダッシュボードを発表できることを大変嬉しく思います。

Docusignでは、リモート監視、ヘルスアラート、ロギング、トラッキング、およびデバッグのための素晴らしい社内モニタリングシステムを使用しています。当社のシステムでは、1時間に1,000万件以上のイベントをログに記録しています。これらのイベントは、ネットワークトラフィックデータからAPIトランザクション、例外、パフォーマンス指標、サービスログ、メタデータなど多岐にわたります。開発者がAPIリクエストを可視化、監視、追跡できるようにしたいと考えた私たちは、API トランザクションデータを非常に安全な方法で開発者に提供するために、私たちのチームとプラットフォーム監視チームが協力してAPI ダッシュボードを開発しました。

これまで、Docusignとの連携・統合を構築している開発者は、アプリケーションの健全性に関する情報を簡単にセルフサービスで入手する方法がありませんでした。開発者として、私は常にサービスの既存および新規の更新を監視し、リクエストログを取得し、レスポンスの詳細と期間を調べ、新機能の健全性に関するアラートを作成するのが好きです。このシステムは、日々の開発サイクルを成功させるのに役立っています。私たちは、開発者がDocusignプラットフォームを使って素晴らしい製品を作ることに成功できるように、開発者にも同じ経験を提供したいと考えています。さらに、顧客は、APIコールによって返される例外によってのみ、1時間ごとのAPI制限を超えたことに気づくことができます。

API Dashboardを使用することで、開発者は統合を監視し、Docusignプラットフォームへの呼び出しに関する定量的および定性的なデータを取得することができます。第一に、開発者は、統合のパフォーマンスの美しいメトリクスとグラフを見ることができます。これは、開発者が Docusign プラットフォーム上に構築されたアプリケーションの最近のAPI呼び出しを表示、デバッグ、ダウンロードする際に非常に役立ちます。最後に、デモ環境から本番までのインテグレーションキーのプロモーションプロセス(Go-Liveプロセス)が合理化され、スムーズになるように、Go-Liveタイムラインを表示することで、より良い体験を提供しています。この機能では、アプリケーションの概要を見ることができる「アプリとキー」ページにもいくつかの更新を行いました。

ダッシュボードは、eSignature Adminにログインでき、それぞれのアカウントのインテグレーションキーを管理する管理者ユーザーがアクセスできるようになっています。

下の図は、Apps and KeysページのAPI Dashboardコンポーネントを示しています（デモ環境と本番環境で利用可能）。

図1：AppsとKeyページ

また、表示ボタンを押し、API Dashboardを表示後、特定のインテグレーションキーのAPI Dashboardに移動することもできます。

図 2: API Dashboard

最近の API コールの詳細を知りたい場合は、[最近の API コール] タブを選択すると、トランザクションデータテーブルが表示されます。また、チャートの上の合計をクリックすると、フィルタリングされたトランザクションのデータテーブルに移動します。

図3: 最近のAPIコール

これらのコールの詳細を知りたいですか? すべてのコールで[表示]を選択すると、リクエストごとの詳細ページに移動し、そのリクエストに関する詳細な情報を提供します。

図4：APIリクエスト/レスポンスの詳細

また、特定のトランザクションを探すために、検索とフィルタ機能を提供したいと考えていました。フィルタアイコンをクリックすると、フィルタリングしたいステータスコードを選択することができ、多くの統合キーをお持ちの場合は、特定のキーを選択して検索をドリルダウンすることができます。また、テキスト検索もあり、最近のAPIコールのStatus Code、API Action Name、Account Nameの列を簡単に調べることができます。ご注意：この記事を書いている時点では、フィルタオプションはクライアント側のトランザクションのみを検索しています。開発者がAPIからフィルタリングしてフィルタリングされたデータを取得できるように、近日中にこれを拡張する予定です。