Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin sites.panel_access; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
⛔ **`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`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Tidak | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Tidak | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
ever_run | boolean | Ya | Has a crawl ever been run for this site? |
running | boolean | Ya | 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 | Ya | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Ya | When the most recent crawl started. Empty when none has run. |
output | string | Ya | The crawler's own output, if it produced any. |
upload | boolean | Ya | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Ya | The change frequencies this site's crawler accepts. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429 · 503