Lingara Lingara 說明文件 學習指南 API 函式庫 應用程式 起造 嵌入 網頁版
語言: 閩南語

共玩家連結到伊的 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"

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

若是翻譯佮英文參考文件無仝,就以英文參考文件為準。