APIの概要

APIの概要#

CrowdHandler は、JSON 形式の RESTful API を提供しています。メソッドには 2 種類あります：

公開API#

パブリックAPIは、ウェブサイト上のユーザーを認証するために使用されます。トークンとURLを送信することで、そのトークンを提示したユーザーに関する詳細情報を取得できます。応答により、そのユーザーがURLへのアクセス許可を事前に取得しているか、あるいは待機室にリダイレクトされるべきかがわかります。その他のメソッドは、ページのパフォーマンスを記録するために使用され、CrowdHandlerがドメインのパフォーマンスを監視できるようにします。

パブリックメソッドへのアクセスには、アカウントごとに一意に割り当てられた公開鍵を使用します。

スタータープランを含むすべてのプランで、パブリックAPIを利用できます。

パブリックAPIには、お客様のドメインの受信レートによる制限以外、レート制限は設けられていません。

非公開API#

プライベートAPIは、アカウント、ドメイン、およびウェイティングルームの管理に使用されます。このAPIを利用すると、管理パネルから利用可能なすべての機能にアクセスできるため、プログラムを介してこれらの機能を操作することができます。

プライベートメソッドには、ご自身のアカウントに固有のプライベートキーを使用してアクセスします。

プライベートメソッドにアクセスできるのは、一部の有料プランのみです。

プライベートAPIには、ご利用のプランに応じたレート制限が適用されます。レート制限は1分あたり100呼び出しからとなります。

APIキーとドキュメントへのアクセス方法#

APIキーとドキュメントは、どちらも管理パネルからアクセスできます。「アカウント」→「API」を選択してください。

これで、API連携のステップバイステップ作業を始める準備が整いました。