public
GET /v1/public/boards/shared/{shareToken}
Open a board someone shared with you. No account needed.
Упълномощаване
Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
shareToken (path) | string | Да | 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… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
status | string<ok> | Да | — |
role | AgencyBoardInviteRole | Да | 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 | Да | 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 | Да | 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 | Да | 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 | Да | 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. |
Грешки, които този крайpoint може да върне
404 · 410 · 429