hosting

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

Start a sitemap crawl.

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα sites.panel_access· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`siteId (path)`	`Uuid`	Ναι	Site ID (UUIDv7).

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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.

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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