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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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