Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran sites.panel_access; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
⛔ **`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 | Diperlukan | Apakah ia |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
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. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
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. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429 · 503