將玩家連結到其 Lingara 帳戶

參數

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"

想用函式庫？請參閱「函式庫」一節。