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"

想用程式庫?睇吓程式庫部分。

如果譯本同英文參考文件有出入,以英文參考文件為準。