将玩家关联到其 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"

更喜欢用库？请参阅“库”部分。