CMS 即時更新

エンドポイント

POST https://geodeck.icu/api/webhook/cms
X-geodeck-Signature: sha256=<hex hmac of raw body>
Content-Type: application/json

ペイロード

{
  "domain": "example.com",
  "url":    "https://example.com/blog/post-slug",
  "event":  "publish"
}

eventはpublish、update、またはunpublishのいずれかである必要があります。

Batch submission

{
  "domain": "example.com",
  "urls": [
    "https://example.com/blog/post-one",
    "https://example.com/blog/post-two"
  ],
  "event": "update"
}

Batch mode accepts up to 500 same-host URLs per signed request. In batch mode, omit title, summary, content, and html.

署名

ドメインのウェブフックシークレットを使用してリクエストボディのrawのHMAC-SHA256を計算します。sha256=プレフィックスを付けて16進数エンコードで送信します。

echo -n "$BODY" | openssl dgst -sha256 -hmac "$SECRET" -hex

レスポンス

• 202 Accepted - ペイロードをキューに入れました。
• 401 Unauthorized - 署名が不足/無効です。
• 401 Unauthorized - 不明なドメインです。
• 402 Payment Required - プランのレート制限に達しました。

リトライ

5xxレスポンスの場合、指数バックオフ（1秒、5秒、30秒、5分）で再試行してください。3回目の失敗後はCMSログにエラーを表示してください。

これはIndexNowやGoogleの標準とどう比べられますか？

geodeck自体のバッチ上限は、より広いエコシステムより小さめです。IndexNowドキュメントはリクエストごとにはるかに大きなバッチを許可しており、IndexNowプロトコルの下で検索エンジンがpingを受信すると、参加している他のすべてのエンジンに自動的に共有されます。GoogleのAI機能に関する公式ドキュメントは、Googleの AI機能に別途webhookやファイル形式が必要ないことを確認しており、そのSearch Console sitemapsヘルプは、このendpointが短縮しようとしている、即時ではない同等の経路をカバーしています。

1回の投稿で最大10,000件のURLを送信でき、必要に応じてhttpとhttpsのURLを混在させることもできます。

— IndexNow documentation

IndexNowプロトコルを採用した検索エンジンは、送信されたURLが参加している他のすべての検索エンジンに自動的に共有されることに同意します。

— IndexNow documentation

成功したリクエストはHTTP 200のレスポンスコードを返します。異なるレスポンスを受け取った場合は、送信頻度が高すぎないか、キーとURLが有効かを確認し、リクエストを再送信してください。

— IndexNow documentation