Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar sites.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
`ever_run` and `running` are separate on purpose: *"you have never generated one"* and *"the last one finished"* are different sentences to a customer and would be the same falsy value in a flatter shape. Requires `sites.view`. `404` for a site with no managed hosting package.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
ever_run | boolean | Evet | Has a crawl ever been run for this site? |
running | boolean | Evet | 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 | Evet | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Evet | When the most recent crawl started. Empty when none has run. |
output | string | Evet | The crawler's own output, if it produced any. |
upload | boolean | Evet | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Evet | The change frequencies this site's crawler accepts. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 429 · 503