Liên kết người chơi với tài khoản Lingara của họ

Tham số

Lingara-Versionheaderstringtùy chọn

Phiên bản API dùng để trả lời yêu cầu này. Nếu không có, token truy cập nhận phiên bản mà ứng dụng khách của nó được gắn, còn yêu cầu không có token nhận phiên bản hiện tại. Phiên bản đang phát triển chỉ có thể dùng bằng cách nêu tên nó ở đây. Phiên bản không xác định được trả lời bằng 400 với mã api_version_unknown. GET /v1/versions liệt kê các phiên bản.

player_refpathstringbắt buộc

player_ref bạn đã dùng để cấp token cho người chơi, được mã hóa phần trăm: guild/42 thành guild%2F42.

Phản hồi

200 Liên kết của người chơi

statusLinkStatusbắt buộc

subjectstringbắt buộc

lgr_sub_ của tài khoản: giá trị mà sự kiện của người chơi này mang từ nay về sau.

previous_subjectstringbắt buộc

lgr_sub_ của khách: giá trị mà các sự kiện trước đó của người chơi giữ lại. Chuyển cả hai về cùng một player_ref.

linked_atstringbắt buộc

Thời điểm tạo liên kết. Với câu trả lời existing, là thời điểm của lần gọi đầu tiên.

scopesarray of stringbắt buộc

Tối đa mà token cho người chơi này giờ có thể giữ: những gì tài khoản đã cấp, trong số các phạm vi mà token của người chơi có thể mang.

carriedobjectbắt buộc

Các hàng mà lần gọi này đã chuyển sang tài khoản, theo từng bảng. Chỉ những bảng có số đếm mới xuất hiện.

keptobjectbắt buộc

Các hàng mà lần gọi này để lại cho khách, theo từng bảng: một kế hoạch còn đang viết, hoặc một hàng mà tài khoản đã có. Hãy gọi lại khi lesson_plans ở đây có một kế hoạch đã hoàn tất.

Lỗi

402application/json

Lệnh gọi của một ứng dụng khách tính phí theo mức dùng đã bị từ chối trước khi tiêu bất cứ thứ gì. spend_cap_reached: ứng dụng khách hoặc tài khoản của nó đã chạm hạn mức chi tiêu hằng tháng; hãy nâng hạn mức trên trang Tích hợp. metered_billing_inactive: tính phí theo mức dùng chưa được kích hoạt cho tài khoản này; hãy thiết lập hoặc cập nhật phương thức thanh toán trên trang Tích hợp.

410application/json

Phiên bản API dùng để trả lời yêu cầu này đã bị ngừng. Hãy gửi một phiên bản được hỗ trợ trong Lingara-Version, hoặc gắn ứng dụng khách với một phiên bản khác.

4XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

503application/json · text/plain

Dịch vụ tạm thời không khả dụng; hãy thử lại sau số giây ghi trong Retry-After. Trong thời gian bảo trì, phần thân là văn bản thuần thay vì phong bì lỗi.

5XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

codestringbắt buộc

Lý do yêu cầu bị từ chối, dưới dạng một mã ổn định để rẽ nhánh: ví dụ insufficient_scope (403), rate_limited (429) và, với ứng dụng khách tính phí theo mức dùng, spend_cap_reached (402) và metered_billing_inactive (402).

errorstringbắt buộc

Ví dụ

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

Muốn dùng thư viện? Xem mục Thư viện.