Tautkan pemain ke akun Lingara mereka

Versi API 2026-10-virile-dragon

put https://api.getlingara.com/v1/embed/players/{player_ref}/link

Menautkan salah satu pemain Anda ke akun Lingara yang baru saja memberi aplikasi Anda akses. Panggil dengan token terdelegasi yang diterima server Anda untuk akun itu, jangan pernah dengan token klien Anda sendiri. Sejak itu token pemain bertindak sebagai akun tersebut, sejauh yang diizinkan pemberian akses: minta events:read atau Anda tidak akan mendengar apa pun tentang pemain setelah penautan. Rencana yang sudah selesai pindah ke akun; rencana yang masih ditulis tetap tinggal sampai Anda memanggil lagi. Aman diulang: pengulangan menjawab existing dan memindahkan apa yang sebelumnya tidak bisa dipindahkan. Penautan tidak dikenai biaya.

Cakupan embed:play

Parameter

Lingara-Versionheaderstringopsional: Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapatkan versi yang disematkan pada kliennya, dan permintaan tanpa token mendapatkan versi saat ini. Versi yang masih dalam pengembangan hanya dapat dicapai dengan menyebutkannya di sini. Versi yang tidak dikenal dijawab 400 dengan kode api_version_unknown. GET /v1/versions mencantumkan versi-versinya.
player_refpathstringwajib: player_ref yang Anda gunakan untuk menerbitkan token pemain, dalam pengodean persen: guild/42 menjadi guild%2F42.

Respons

200 Tautan pemain

statusLinkStatuswajib
subjectstringwajib: lgr_sub_ milik akun: yang dibawa peristiwa pemain ini mulai sekarang.
previous_subjectstringwajib: lgr_sub_ milik tamu: yang dipertahankan peristiwa pemain sebelumnya. Arahkan keduanya ke player_ref yang sama.
linked_atstringwajib: Kapan tautan dibuat. Pada jawaban existing, waktu panggilan pertama.
scopesarray of stringwajib: Paling banyak yang dapat dimiliki token untuk pemain ini sekarang: yang diizinkan akun, dari cakupan yang dapat dibawa token pemain.
carriedobjectwajib: Baris yang dipindahkan panggilan ini ke akun, per tabel. Hanya tabel dengan jumlah yang muncul.
keptobjectwajib: Baris yang ditinggalkan panggilan ini pada tamu, per tabel: rencana yang masih ditulis, atau baris yang sudah dimiliki akun. Panggil lagi setelah lesson_plans di sini memiliki rencana yang sudah selesai.

Galat

402application/json: Panggilan klien dengan penagihan per pemakaian ditolak sebelum menghabiskan apa pun. spend_cap_reached: klien atau akunnya telah mencapai batas pengeluaran bulanannya; naikkan batasnya di halaman Integrasi. metered_billing_inactive: penagihan per pemakaian tidak aktif untuk akun ini; siapkan, atau perbarui metode pembayarannya, di halaman Integrasi.
410application/json: Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Kirim versi yang didukung di Lingara-Version, atau sematkan klien ke versi lain.
4XXapplication/json: Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.
503application/json · text/plain: Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat.
5XXapplication/json: Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

codestringwajib: Alasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya insufficient_scope (403), rate_limited (429) dan, untuk klien dengan penagihan per pemakaian, spend_cap_reached (402) dan metered_billing_inactive (402).
errorstringwajib

Contoh

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

Lebih suka pustaka? Lihat bagian Pustaka.

Jika terjemahan berbeda dengan referensi berbahasa Inggris, referensi berbahasa Inggris yang berlaku.