Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cms-target \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
The site's content target. Gated on `links.view`. ⛔ A site with no configured target is **200, not 404**. Most WordPress sites on our own fleet need no configuration at all — we hold a managed shell on the box, so the target is derived from the site — and the response then describes that derived target and its capabilities with `hasCredential: false`. Treating "no row" as "no target" would report most of the estate as unconfigured. ⛔ No secret is ever returned, in any form — not masked, not last-four. `hasCredential` is a boolean and the only consumer of the value is the adapter making the call.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
siteId (path) | string | Ya | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
site_id | string | Ya | — |
kind | string<, wordpress, headless_rest, git_static> | Ya | Empty when nothing claims this site. For a site with no configured row this is the **derived** target — most WordPress sites on our own fleet need no configuration at all, becau… |
preset | string<, payload, strapi, directus, ghost, shopify, webflow, custom> | Ya | — |
base_url | string | Ya | The CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository). |
collection | string | Ya | The collection posts are created in — `posts` on Payload, a blog id on Shopify, a collection id on Webflow, the content directory on a Git target. |
auth_scheme | string<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header> | Ya | — |
auth_header | string | Ya | For the `header` auth scheme — which header the key is sent in. |
field_map | object | Ya | Renames, for a destination that spells our fields differently. ⛔ It **renames**; it never adds a capability. A field map cannot make a target able to carry a tag it has no field… |
enabled | boolean | Ya | A disabled target is skipped and reads as `needs_setup` — kept rather than deleted so pausing publishing to a site does not lose its set-up. |
has_credential | boolean | Ya | — |
capabilities | string[] | Ya | — |
detected_identity | string | Ya | What the destination said it was, last time it answered. |
last_probe_at | string | Ya | — |
last_probe_reachable | boolean | Ya | ⛔ `null` means **never probed**; `false` means probed and could not be reached. Those are different facts and a client must not render them the same. |
last_probe_code | string | Ya | — |
last_probe_detail | string | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404