public
GET /v1/public/boards/shared/{shareToken}
Open a board someone shared with you. No account needed.
Autentikasi
Titik akhir ini bersifat publik. Titik akhir ini tidak memerlukan kredensial maupun organisasi—inilah yang dibaca oleh situs pemasaran kami sendiri dan mesin jawaban AI.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
**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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
shareToken (path) | string | Ya | 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… |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
status | string<ok> | Ya | — |
role | AgencyBoardInviteRole | Ya | 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 | Ya | 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 | Ya | 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 | Ya | 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 | Ya | 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. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
404 · 410 · 429