links
GET /v1/content/targets
Which of your sites can receive a post, and why the rest cannot.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/content/targets \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Every live site in scope with its suitability: can it take an article, and — when it cannot — whose fact that is. Gated on links.view. ⛔⛔ suitability has five values and the difference between two of them is the whole point of this endpoint. unsuitable is measured: every adapter was asked which sites it claims and each one declined, so this kind of site genuinely has nowhere to put an article. unknown means we could not determine it — the box was unreachable, the credential has never been tested, or nothing has checked this site yet. A client MUST NOT render unknown as a refusal, MUST NOT silently exclude it from a selection, and SHOULD count it separately in any confirmation ("9 ready, 3 unchecked"). Treating "we could not look" as "no" is the defect this endpoint exists to prevent. ⛔ This endpoint makes no outbound calls. Suitability is served from the last stored probe with checkedAt beside it, because probing every row of a 500-site page would be an uncached external call in an interactive path. checkedAt: null means never checked and MUST be shown as such, not as a fresh result. Use probeContentTargets to refresh. ⭐ requires takes capability ids a recipe needs; each row then carries missingCapabilities, so an editor can grey a site out and say what it cannot do. A site whose capabilities are not established reports nothing missing rather than everything missing — for the same reason unknown is not unsuitable.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | string | Nem | Narrow to one organisation in a reseller subtree. Can never widen scope. |
q (query) | string | Nem | Match on domain or site name. |
suitability (query) | string<ready, needs_setup, unknown, unsuitable, blocked> | Nem | — |
product_line (query) | string | Nem | — |
stack_type (query) | string | Nem | — |
group_id (query) | string | Nem | Only sites in this site group. |
cms (query) | string<wordpress, headless_rest, git_static> | Nem | Only sites whose target is this kind. |
requires (query) | string | Nem | Comma-separated capability ids a recipe requires, e.g. cms_target:featured_image,cms_target:category. |
limit (query) | integer | Nem | — |
offset (query) | integer | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
items | SiteTarget[] | Igen | — |
total | integer | Igen | Every site matching the filters, not the page. This is the number a select-all-matching control shows. |
offset | integer | Igen | — |
limit | integer | Igen | — |
has_more | boolean | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422