Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen sites.panel_access; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
⛔ **`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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
siteId (path) | Uuid | Po | Site ID (UUIDv7). |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Jo | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Jo | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
ever_run | boolean | Po | Has a crawl ever been run for this site? |
running | boolean | Po | 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 | Po | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Po | When the most recent crawl started. Empty when none has run. |
output | string | Po | The crawler's own output, if it produced any. |
upload | boolean | Po | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Po | The change frequencies this site's crawler accepts. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 422 · 429 · 503