public
GET /v1/public/boards/shared/{shareToken}
Open a board someone shared with you. No account needed.
Autentizace
Tento koncový bod je veřejný. Nevyžaduje žádná pověření ani organizaci – je to to, co čte náš vlastní marketingový web a naše AI vyhledávače.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
**Unauthenticated.** The token in the path is the whole authorisation: whoever holds it holds the grant, which is what makes the link pasteable into a channel we do not control. What comes back is the **client projection** — the same field-listed view the agency's client gets in their own console, and literally the same code path. Anything the agency marked internal is excluded at the queryset, not in the UI. ⭐ `sign_in` names the brand whose board this is, resolved by walking **up** the organisation tree, so a reseller's client is sent to the reseller's branded login and never to ours. `requires_account` answers "must I register?" as data, so a client never has to work out the rule from the role name.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
shareToken (path) | string | Ano | The share link's bearer token, as it appears in the URL somebody pasted. **This is a credential**: 256 bits from a CSPRNG behind a `zbi_` prefix, and whoever holds it holds the… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
status | string<ok> | Ano | — |
role | AgencyBoardInviteRole | Ano | What a share link grants. `viewer` is **link-only**: it creates no board seat and no organisation membership, because it grants no identity — it is read-through-the-token, which… |
requires_account | boolean | Ano | Whether the visitor must sign in before they can do anything. `false` for a `viewer` link — they can read this board with no Zinn® account at all. |
shared_by | string | Ano | The **brand** whose board this is, resolved by walking up the organisation tree — so a reseller's client is told the reseller's name, not the client org's and not ours. |
sign_in | SharedBoardSignIn | Ano | Where this board's visitors sign in, and under whose name. ⛔⛔ Computed by the engine from the board, because nothing downstream knows whose board it is: the dashboard reads one… |
board | SharedAgencyBoardDetail | Ano | The client projection — the same field-listed view the agency's own client gets, produced by the same code. Anything marked internal is excluded at the queryset. |
Chyby, které může tento koncový bod vrátit
404 · 410 · 429