Contix Pro にはスコープ付きの REST API キーと署名付き Webhook があり、他のシステムから Contix の処理を開始したり、完了の通知を受け取ったりできます。どちらも管理者が作成した後にのみ機能します。
場所: ARN Contix → システム → 連携。上部でプロジェクトのコンテキストを選択し、連携ワークスペースを開く をクリックします。同じ画面の Google Search Console 接続については Google Search Console でパフォーマンスを追跡する をご覧ください。

REST API キーを作成する
- 1. REST API キー で 名前 を入力します。
- プロジェクトの紐付け で すべてのプロジェクト または特定のプロジェクトを選択します。1 つのプロジェクトに紐付けたキーは、そのプロジェクト(
project_id)を指定したリクエストでのみ機能し、プロジェクトを作成することはできません。紐付けたキーでもGET /statusを呼び出せ、GET /projectsは紐付けたプロジェクトのみを返します。 - キーに必要な スコープ にチェックを入れます。
- API キーを作成 をクリックします。
新しいキーは一度だけ表示されます。すぐにコピーして安全に保管してください。Contix はキーをソルト付きハッシュとしてのみ保存するため、再表示することはできません。
キーの一覧には 名前、キーの 接頭辞、スコープ、最終使用日時 が表示されます。キーを無効にするには 取り消す をクリックします。以降、そのキーを使用したリクエストは拒否されます。
スコープとエンドポイント
すべてのエンドポイントは /wp-json/contix/v1/ 配下にあります。キーは Authorization ヘッダーで、Bearer の後にキーを続けて送信してください。
| メソッドとエンドポイント | スコープ | 内容 |
|---|---|---|
GET /status | system.read | Contix のバージョン、スキーマ、ランタイムが一時停止中かどうかを返します |
GET /projects | projects.read | プロジェクトを一覧表示します。1 つのプロジェクトに紐付けたキーの場合はそのプロジェクトのみ |
POST /projects | projects.write | プロジェクトを作成します(name、language、region、brand_summary、content_goal) |
GET /projects/{project_id}/topics | topics.read | プロジェクトのトピックを一覧表示します |
POST /projects/{project_id}/topics | topics.write | トピックを作成します(keyword、secondary_keywords、content_type、search_intent、audience、language、region、goal、priority) |
POST /pipeline/start | pipeline.write | 実行を開始します(project_id、topic_id、mode は automatic または guided) |
GET /pipeline/{run_id}?project_id={project_id} | pipeline.read | 実行のステータスを返します |
GET /projects/{project_id}/topics/{topic_id}/results | results.read | 記事の下書き、分析、公開パッケージなど、トピックの保存済み結果を返します |
GET /projects/{project_id}/jobs | jobs.read | プロジェクトの最近のジョブを一覧表示します |
GET /projects/{project_id}/connectors | connectors.read | プロジェクトのコネクターを一覧表示します |
各キーは 1 分あたり 120 リクエストに制限されています。主な応答は次のとおりです。
| ステータス | 意味 |
|---|---|
| 401 | キーがない、無効、または取り消されています |
| 403 | キーにこのスコープが付与されていない、別のプロジェクトに紐付けられている、または紐付けられたキーでプロジェクトを作成しようとしました |
| 409 | 実行を開始できませんでした。理由はメッセージに表示されます |
| 422 | プロジェクトまたはトピックを作成できませんでした。フィールドを確認してください |
| 429 | キーが 1 分あたり 120 リクエストを超えました |
認証されたすべてのリクエストは Contix のログに記録されます。
署名付き Webhook を作成する
- 3. 署名付き Webhook で、名前 と HTTPS エンドポイント を入力します。
- 必要な イベント にチェックを入れます:
job.completed、job.failed、pipeline.completed、pipeline.failed、publish.completed、publish.failed。 - Webhook を作成 をクリックします。
署名シークレットは一度しか表示されないため、すぐにコピーしてください。受け付けられるのは公開 HTTPS アドレスのみで、プライベートおよび予約済みのネットワークアドレスは拒否されます。
Webhook の表には、イベント、配信の成功数と失敗数、最後のステータスが表示されます。Webhook を削除するには 削除 をクリックします。
Webhook の配信を検証する
Contix は各イベントを、次のヘッダー付きの JSON POST として送信します。
| ヘッダー | 内容 |
|---|---|
X-Contix-Event | イベントの種類(例:pipeline.completed) |
X-Contix-Delivery | 一定の配信 ID。処理済みの配信を無視するために使用します |
X-Contix-Timestamp | 配信時刻(Unix タイムスタンプ) |
X-Contix-Signature | v1= に続く署名 |
署名は、タイムスタンプ、ピリオド、未加工のリクエスト本文(timestamp.body)を、署名シークレットをキーとして計算した 16 進数の HMAC-SHA256 です。リクエストを信頼する前に、受信側で署名を計算してヘッダーと照合してください。
エンドポイントが 2xx ステータスで応答すると、配信は成功と見なされます。ネットワークエラーや、ステータス 429 または 5xx の応答はキューを通じて再試行されます。リダイレクトは追跡されません。