メインコンテンツにスキップ

開発者向け API と Webhook

デベロッパーセンターから、API キーの作成、Webhook エンドポイントの登録、リクエストログの確認ができます。

対応者:Sarah Chen

開発者センター は、Exayard を独自のコードやツールに接続する場所です。設定 から 開発者 を開きます。ここでは、API キーの作成、Webhook エンドポイントの登録、すべての API リクエストのライブログの確認ができます。このページにアクセスできるのは組織の管理者のみです。

API キー

API キー は、Exayard API へのリクエストを認証します。キーは組織に属するため、適切なアカウントが自動的に選択され、渡す組織 ID はありません。

クレデンシャル カードの API キー タブを開き、+ ボタンをクリックします。キーに 名前 を付け、その スコープ を選びます。すべてのスコープを付与するには すべて を、個別の権限を選ぶには 特定 を選択します。スコープはリソースごとに読み取りと書き込みに分かれており、read:projectswrite:estimates のような形式です。admin:org スコープはフルアクセスの付与です。連携に必要な最小限のスコープを選んでください。

Exayard は、作成直後の一度だけ完全なキーを表示します。その後は二度と表示されないため、そのときにコピーしてください。それ以降、各キーは名前、ak_••••1234 のようなマスクされたプレビュー、最終使用日とともに表示されます。

鉛筆アイコンを使うと、キーの名前変更やスコープの変更ができます。ゴミ箱アイコンを使うと、キーを 取り消し できます。取り消しは永続的で、そのキーを使っている連携はただちに動作を停止します。

同じキーが、ノーコード連携の認証にも使われます。Exayard を Zapier に接続するExayard を Make に接続するExayard を n8n に接続するをご覧ください。エージェントや AI エディターからのアクセスについては、Claude やその他の AI ツールに接続するをご覧ください。

Webhook

Webhook は、何かが起きたときにサーバーへ通知するよう Exayard に指示します。Webhook タブを開き、+ をクリックしてエンドポイントを追加します。配信を受け取る URL と、任意の 説明 を入力します。

購読する イベント を選びます。すべてのイベントを受け取るには すべて を、リストから選ぶには 特定 を選択します。

イベント

発生タイミング

project.created

プロジェクトが作成されたとき

project.updated

プロジェクトが変更されたとき

project.archived

プロジェクトがアーカイブされたとき

assessment.started

拾い出しアセスメントが始まったとき

assessment.completed

アセスメントが完了したとき

assessment.approved

アセスメントが承認されたとき

assessment.cancelled

アセスメントがキャンセルされたとき

estimate.generated

見積もりが生成されたとき

bid.generated

入札書が生成されたとき

file.processed

アップロードされたファイルの処理が完了したとき

エンドポイントを作成すると、Exayard は 署名シークレット を一度だけ表示します。二度と表示されないため、そのときにコピーしてください。

Webhook 配信のセキュリティ確保

すべての配信には、t=<unix>,v1=<digest> という形式の Exayard-Signature ヘッダーが付きます。Exayard は、タイムスタンプとリクエストボディを連結し、エンドポイントシークレットを使って HMAC-SHA256 で署名することで、この署名を生成します。

配信を検証するには、自分のシークレットで署名を再計算し、タイムスタンプが現在時刻から 5 分以内であることを確認し、ダイジェストを比較します。失敗した配信は、おおよそ 3 日間にわたり指数バックオフで再試行されます。

エンドポイントを編集するには、鉛筆アイコンをクリックします。URL、説明、イベントを変更でき、ステータス有効 または 一時停止 に設定できます。一時停止されたエンドポイントは配信の受信を停止します。同じダイアログには シークレットをローテーション ボタンがあります。ローテーションすると新しいシークレットが発行され、古いシークレットはただちに無効になるため、ローテーションする前にサーバーを更新してください。ゴミ箱アイコンはエンドポイントを削除し、そこへのすべての配信を終了します。

クイックスタート

クイックスタート カードには、Claude や Cursor のような AI エディター向けの、すぐに使えるプロンプトが用意されています。プロンプトをコピー をクリックして、エディターに貼り付けます。このプロンプトには、API のベース URL、認証形式、スコープの語彙、Webhook の署名方式が含まれているため、AI は動作する連携の土台を作り、必要な詳細をあなたに尋ねられます。

ドキュメント

ドキュメント カードには、完全な開発者ドキュメントと、すべてのルートとスキーマを記述した OpenAPI スペック へのリンクがあります。Connect MCP を開くと、AI エージェントを Exayard に直接接続するためのセットアップが開きます。

ログ

ログ セクションには、REST API と MCP の両方にわたる最近の API リクエストが記録されます。各行には、メソッド、パス、応答ステータス、レイテンシが表示されます。行を選択すると、リクエスト ID やリクエストボディと応答ボディを含む完全な詳細が表示されます。ログを使って、呼び出しが成功したかを確認したり、失敗した連携をデバッグしたりできます。

こちらの回答で解決しましたか?