Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 嵌入 網頁版
語言: 客家話

將玩家連結到其 Lingara 帳號

API 版本 2026-10-virile-dragon

put https://api.getlingara.com/v1/embed/players/{player_ref}/link

將你个一隻玩家連結到啱啱授權分你个應用程式个 Lingara 帳號。用你个伺服器為該帳號收到个委派權杖來呼叫,毋好用你用戶端自家个權杖。從此以後,玩家个權杖會以該帳號个身份行動,範圍以授權為限:請求 events:read,無就連結以後你聽毋到玩家个任何消息。完成个計畫會移到帳號;還在寫个計畫會留等你再呼叫。可以放心重複:重複會回應 existing,並移動先前移毋動个內容。連結毋使你出任何費用。

權限範圍 embed:play

參數

Lingara-Versionheaderstring選填
回應這隻請求所用个 API 版本。無這隻个話,存取權杖會用佢个用戶端綁定个版本,無權杖个請求會用這下个版本。還在開發个版本,淨係在這位講明正用得到。無認識个版本會回 400,代碼係 api_version_unknown。GET /v1/versions 會列出所有版本。
player_refpathstring必填
你同這隻玩家簽發權杖个時節用个 player_ref,經過百分比編碼:guild/42 寫做 guild%2F42。

回應

200 玩家个連結

statusLinkStatus必填
subjectstring必填

帳號个 lgr_sub_:這隻玩家个事件從今以後攜帶个識別。

previous_subjectstring必填

訪客个 lgr_sub_:玩家較早事件保留个識別。兩隻都轉送到同一隻 player_ref。

linked_atstring必填

連結建立个時間。在 existing 回應中,係第一擺呼叫个時間。

scopesarray of string必填

這隻玩家个權杖這下最多做得持有个權限:帳號授權个、玩家權杖做得攜帶个範圍。

carriedobject必填

這擺呼叫移到帳號个資料列,按資料表分。淨有數量个資料表會出現。

keptobject必填

這擺呼叫留分訪客个資料列,按資料表分:還在寫个計畫,或者帳號早就有个資料列。等這位个 lesson_plans 有完成个計畫以後再呼叫一擺。

錯誤

402application/json
一隻按用量計費个用戶端个呼叫,在佢用忒任何東西之前就分人拒絕了。spend_cap_reached:用戶端抑係佢个帳戶已經到了每月个花費上限;請在整合頁面調高上限。metered_billing_inactive:這隻帳戶个按用量計費還毋曾啟用;請在整合頁面設定,抑係更新付款方式。
410application/json
回應這隻請求所用个 API 版本已經停用。請在 Lingara-Version 送一隻有支援个版本,或者將用戶端綁到別隻版本。
4XXapplication/json
請求分人拒絕了。code 講原因,error 用文字講明。
503application/json · text/plain
服務暫時用毋得;請等 Retry-After 裡肚个秒數過後再試。維護期間,內容係純文字,毋係錯誤封包。
5XXapplication/json
請求分人拒絕了。code 講原因,error 用文字講明。
codestring必填

請求分人拒絕个原因,係一隻穩定个代碼,做得用來分支處理:比如 insufficient_scope(403)、rate_limited(429),對按用量計費个用戶端還有 spend_cap_reached(402)㧯 metered_billing_inactive(402)。

errorstring必填

範例

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

想用函式庫?請看函式庫這一節。

假使翻譯㧯英文參考文件無共樣,就以英文參考文件為準。