public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
စစ်မှန်ကြောင်း အတည်ပြုခြင်း
API သော့တစ်ခုကို bearer token အဖြစ် ပေးပို့ပါ။ ဤ အမှတ်အသားအဆုံး (endpoint) သည် သတ်မှတ်ချက်တွင် တိကျသော ခွင့်ပြုချက်တစ်ခုကို မဖော်ပြထားပါသဖြင့်၊ သင့်သော့ကို အနည်းဆုံး လိုအပ်သည်များသာ ပေးအပ်ပြီး မူလအခြေအနေကို ယူဆမည့်အစား တုံ့ပြန်မှုကို စစ်ဆေးပါ။
ဤ အမှတ်ဆက် (endpoint) သည် အဖွဲ့အစည်း အိုင်ဒီ (organisation id) ကို မယူပါ။ သင်၏ သော့ချက် (key) သည် ၎င်းပိုင်ဆိုင်သည့် အဖွဲ့အစည်းကို အလိုအလျောက် ဖော်ထုတ်ပြီးဖြစ်ကာ တုံ့ပြန်ချက်ကိုလည်း ၎င်းနှင့်သာ ကန့်သတ်ထားမည် ဖြစ်သည်။
စမ်းကြည့်ရန်
ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"ဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို API ကွန်ဆိုးလ်တွင် ဖွင့်ပါ
အသေးစိတ်အချက်အလက်များ
Requires a signed-in person — this is the *"one screen from the invite, with the board waiting on the other side"* half of the flow. A `viewer` link needs no join and says so rather than refusing, because a UI offering **Join** on a read-only link is a UI bug and the honest answer costs one field. Idempotent: somebody already on the board gets their existing seat back and it does **not** consume one of the link's uses. A client who bookmarks the link and opens it every Monday must not exhaust a 5-use link by themselves.
ကန့်သတ်ဘောင်များ
| နာမည် | အမျိုးအစား | လိုအပ်သည် | ဘာလဲဆိုတာ |
|---|---|---|---|
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… |
တုံ့ပြန်ချက်
| နာမည် | အမျိုးအစား | လိုအပ်သည် | ဘာလဲဆိုတာ |
|---|---|---|---|
joined | boolean | ဟုတ်ကဲ့ | — |
seated | boolean | မဟုတ်ပါ | Whether this call created the seat, as opposed to returning an existing one. |
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… |
board_id | Uuid | ဟုတ်ကဲ့ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | မဟုတ်ပါ | — |
detail | string | မဟုတ်ပါ | — |
ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ
401 · 404 · 410 · 422