public

GET /v1/public/boards/shared/{shareToken}

Open a board someone shared with you. No account needed.

ټول public پای ټکي

تصدیق‌هویت

دا پای ټکی عامه دی. دا هېڅ اعتبار او هېڅ سازمان ته اړتیا نه لري - دا هغه څه دي چې زموږ خپله د بازار موندنې پاڼه او د مصنوعي ځيرکتیا د ځواب انجنونه یې لولي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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…

ځواب

نومډولاړیندا څه شی دی
statusstring<ok>هو
roleAgencyBoardInviteRoleهو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_accountbooleanهو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_bystringهو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_inSharedBoardSignInهو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…
boardSharedAgencyBoardDetailهو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.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

404 · 410 · 429