Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.panel_access beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
⛔ **`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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | Nee | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | Nee | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
ever_run | boolean | Ja | Has a crawl ever been run for this site? |
running | boolean | Ja | 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 | Ja | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Ja | When the most recent crawl started. Empty when none has run. |
output | string | Ja | The crawler's own output, if it produced any. |
upload | boolean | Ja | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Ja | The change frequencies this site's crawler accepts. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429 · 503