ARN Smart Support
言語: 日本語

REST API キーと署名付き Webhook(Pro)

更新日: 19 11月 2026 1分で読めます
Contix の記事を見る

Contix Pro にはスコープ付きの REST API キーと署名付き Webhook があり、他のシステムから Contix の処理を開始したり、完了の通知を受け取ったりできます。どちらも管理者が作成した後にのみ機能します。

場所: ARN Contix → システム → 連携。上部でプロジェクトのコンテキストを選択し、連携ワークスペースを開く をクリックします。同じ画面の Google Search Console 接続については Google Search Console でパフォーマンスを追跡する をご覧ください。

REST API スコープ、Search Console 接続、署名付き Webhook 設定が表示された Contix の連携画面(キーは非表示)

REST API キーを作成する

  1. 1. REST API キー で 名前 を入力します。
  2. プロジェクトの紐付け で すべてのプロジェクト または特定のプロジェクトを選択します。1 つのプロジェクトに紐付けたキーは、そのプロジェクト(project_id)を指定したリクエストでのみ機能し、プロジェクトを作成することはできません。紐付けたキーでも GET /status を呼び出せ、GET /projects は紐付けたプロジェクトのみを返します。
  3. キーに必要な スコープ にチェックを入れます。
  4. API キーを作成 をクリックします。

新しいキーは一度だけ表示されます。すぐにコピーして安全に保管してください。Contix はキーをソルト付きハッシュとしてのみ保存するため、再表示することはできません。

キーの一覧には 名前、キーの 接頭辞、スコープ、最終使用日時 が表示されます。キーを無効にするには 取り消す をクリックします。以降、そのキーを使用したリクエストは拒否されます。

スコープとエンドポイント

すべてのエンドポイントは /wp-json/contix/v1/ 配下にあります。キーは Authorization ヘッダーで、Bearer の後にキーを続けて送信してください。

メソッドとエンドポイントスコープ内容
GET /statussystem.readContix のバージョン、スキーマ、ランタイムが一時停止中かどうかを返します
GET /projectsprojects.readプロジェクトを一覧表示します。1 つのプロジェクトに紐付けたキーの場合はそのプロジェクトのみ
POST /projectsprojects.writeプロジェクトを作成します(name、language、region、brand_summary、content_goal)
GET /projects/{project_id}/topicstopics.readプロジェクトのトピックを一覧表示します
POST /projects/{project_id}/topicstopics.writeトピックを作成します(keyword、secondary_keywords、content_type、search_intent、audience、language、region、goal、priority)
POST /pipeline/startpipeline.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}/resultsresults.read記事の下書き、分析、公開パッケージなど、トピックの保存済み結果を返します
GET /projects/{project_id}/jobsjobs.readプロジェクトの最近のジョブを一覧表示します
GET /projects/{project_id}/connectorsconnectors.readプロジェクトのコネクターを一覧表示します

各キーは 1 分あたり 120 リクエストに制限されています。主な応答は次のとおりです。

ステータス意味
401キーがない、無効、または取り消されています
403キーにこのスコープが付与されていない、別のプロジェクトに紐付けられている、または紐付けられたキーでプロジェクトを作成しようとしました
409実行を開始できませんでした。理由はメッセージに表示されます
422プロジェクトまたはトピックを作成できませんでした。フィールドを確認してください
429キーが 1 分あたり 120 リクエストを超えました

認証されたすべてのリクエストは Contix のログに記録されます。

署名付き Webhook を作成する

  1. 3. 署名付き Webhook で、名前 と HTTPS エンドポイント を入力します。
  2. 必要な イベント にチェックを入れます:job.completed、job.failed、pipeline.completed、pipeline.failed、publish.completed、publish.failed。
  3. Webhook を作成 をクリックします。

署名シークレットは一度しか表示されないため、すぐにコピーしてください。受け付けられるのは公開 HTTPS アドレスのみで、プライベートおよび予約済みのネットワークアドレスは拒否されます。

Webhook の表には、イベント、配信の成功数と失敗数、最後のステータスが表示されます。Webhook を削除するには 削除 をクリックします。

Webhook の配信を検証する

Contix は各イベントを、次のヘッダー付きの JSON POST として送信します。

ヘッダー内容
X-Contix-Eventイベントの種類(例:pipeline.completed)
X-Contix-Delivery一定の配信 ID。処理済みの配信を無視するために使用します
X-Contix-Timestamp配信時刻(Unix タイムスタンプ)
X-Contix-Signaturev1= に続く署名

署名は、タイムスタンプ、ピリオド、未加工のリクエスト本文(timestamp.body)を、署名シークレットをキーとして計算した 16 進数の HMAC-SHA256 です。リクエストを信頼する前に、受信側で署名を計算してヘッダーと照合してください。

エンドポイントが 2xx ステータスで応答すると、配信は成功と見なされます。ネットワークエラーや、ステータス 429 または 5xx の応答はキューを通じて再試行されます。リダイレクトは追跡されません。

関連記事

このページの内容

チケットを送信

ポータルアカウントなしで新しいサポートリクエストを作成します。

優先度
添付ファイル
チケットはお客様とスタッフのみが閲覧できます。パスワードやライセンスコードは送信しないでください。

チケットを確認

確認メールに記載のチケット番号とパスワードを入力してください。

番号とパスワードは確認メールに記載されています。

ログイン

サポートポータルのアカウントにアクセスします。

アカウントをお持ちでない方

アカウントを作成

サポートポータルのアカウントを作成してください。

アカウントをお持ちですか?

パスワードをお忘れですか?

新しいパスワードを設定するためのリンクをメールでお送りします。

やり取り

この情報は役に立ちましたか?
記事全文を開く
↑ ↓ で移動Enter で開くEsc で閉じる