認証
ベアラー トークンとして API キーを送信します。キーには sites.panel_access 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ **`202`, and the returned state describes a job that has STARTED.** A crawler walks the whole site and may take minutes; the sitemap does not exist when this returns. Poll `getSiteSitemap` until `running` is false. Answering `200` here would be the status-code equivalent of telling the customer their sitemap is ready. `upload` writes `sitemap.xml` into the webspace, overwriting any existing file. Requires `sites.panel_access`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | いいえ | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | いいえ | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
ever_run | boolean | はい | Has a crawl ever been run for this site? |
running | boolean | はい | Is a crawl in progress? ⛔ Computed as *not in a terminal state*, so a state we have never seen reads as still working rather than as finished. |
state | string | はい | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | はい | When the most recent crawl started. Empty when none has run. |
output | string | はい | The crawler's own output, if it produced any. |
upload | boolean | はい | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | はい | The change frequencies this site's crawler accepts. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503