Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте sites.panel_access рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Жүйеге кіргенсіз бе? Бақылау тақтасындағы 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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
siteId (path) | Uuid | Иә | Site ID (UUIDv7). |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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