Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea sites.panel_access; o cheie care nu o are va fi respinsă cu 403, nu 404.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
⛔ **`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`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
siteId (path) | Uuid | Da | Site ID (UUIDv7). |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Nu | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Nu | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
ever_run | boolean | Da | Has a crawl ever been run for this site? |
running | boolean | Da | 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 | Da | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Da | When the most recent crawl started. Empty when none has run. |
output | string | Da | The crawler's own output, if it produced any. |
upload | boolean | Da | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Da | The change frequencies this site's crawler accepts. |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422 · 429 · 503