hosting

POST `/v1/sites/{siteId}/sitemap`

Start a sitemap crawl.

Doğrulama

API açarını bearer token kimi göndərin. Açar sites.panel_access icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

⛔ 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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`siteId (path)`	`Uuid`	Bəli	Site ID (UUIDv7).

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`frequency`	`string<always, hourly, daily, weekly, monthly, never, yearly>`	Xeyr	The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee.
`upload`	`boolean`	Xeyr	Overwrite `sitemap.xml` in the webspace when the crawl finishes.

Cavab

Ad	Tip	Tələb olunur	Nədir
`ever_run`	`boolean`	Bəli	Has a crawl ever been run for this site?
`running`	`boolean`	Bəli	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`	Bəli	The vendor's own job state, verbatim. Empty when none has run.
`created_at`	`string`	Bəli	When the most recent crawl started. Empty when none has run.
`output`	`string`	Bəli	The crawler's own output, if it produced any.
`upload`	`boolean`	Bəli	Whether the crawl writes `sitemap.xml` into the webspace.
`frequencies`	`string[]`	Bəli	The change frequencies this site's crawler accepts.

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/sitemap