hosting
POST /v1/sites/{siteId}/sitemap
Start a sitemap crawl.
Санҷиши ҳаққоният
Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати sites.panel_access бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.
Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
⛔ 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.
Параметрҳо
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
siteId (path) | Uuid | Бале | Site ID (UUIDv7). |
Ҷисми дархост
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Не | The changefreq written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Не | Overwrite sitemap.xml in the webspace when the crawl finishes. |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
ever_run | boolean | Бале | Has a crawl ever been run for this site? |
running | boolean | Бале | 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 | Бале | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Бале | When the most recent crawl started. Empty when none has run. |
output | string | Бале | The crawler's own output, if it produced any. |
upload | boolean | Бале | Whether the crawl writes sitemap.xml into the webspace. |
frequencies | string[] | Бале | The change frequencies this site's crawler accepts. |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 404 · 422 · 429 · 503