hosting

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

Start a sitemap crawl.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.panel_access؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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

POST /v1/sites/{siteId}/sitemap