Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit sites.panel_access ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
⛔ **`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`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
siteId (path) | Uuid | Ha | Site ID (UUIDv7). |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Yo'q | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Yo'q | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
ever_run | boolean | Ha | Has a crawl ever been run for this site? |
running | boolean | Ha | 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 | Ha | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Ha | When the most recent crawl started. Empty when none has run. |
output | string | Ha | The crawler's own output, if it produced any. |
upload | boolean | Ha | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Ha | The change frequencies this site's crawler accepts. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422 · 429 · 503