Menyematkan Lingara

Halaman ini diterjemahkan dari bahasa Inggris. Jika keduanya berbeda, halaman bahasa Inggris yang benar. Baca halaman bahasa Inggris

Lingara dapat berada di dalam game atau situs web Anda. Karakter di dunia Anda dapat bercakap pada tingkat pemain, dan latihan yang diselesaikan pemain Anda dihitung sebagai latihan Lingara. Sematan ini memiliki dua bagian, dan hal pertama yang perlu ditentukan adalah bagian mana yang berjalan di mana.

Siapa memegang apa

Server Anda memegang secret klien OAuth Anda dan secret penandatanganan webhook Anda. Keduanya tidak pernah meninggalkan server.

Perangkat pemain memegang satu hal: token sematan, yang diawali dengan lgr_et_. Apa pun yang Anda kirimkan di dalam biner game atau halaman web bersifat publik, sehingga perangkat tidak pernah memegang secret klien, secret webhook, atau token akses dari klien Anda sendiri. Token sematan bertindak untuk satu pemain saja, berlaku beberapa menit alih-alih beberapa jam, dan hanya memegang scope yang diberikan server Anda kepadanya.

Pemain tidak memerlukan akun Lingara. Token pertama yang dicetak server Anda untuk seorang pemain membuat pelajar tamu untuk mereka, dan setiap token berikutnya menjangkau pelajar yang sama. Pemain yang sudah memiliki akun Lingara dapat membawanya: halaman kit server menjelaskan cara server Anda menautkan keduanya.

Cara token sampai ke pemain

1. Kit pemain, di game Anda atau di halaman Anda, membutuhkan token dan memintanya ke server Anda melalui sumber tokennya.
2. Server Anda memeriksa sesinya sendiri untuk pemain itu dan mencetak token untuk mereka dengan kit server.
3. Server Anda mengembalikan token sebagai dua field, token dan waktu kedaluwarsanya, melalui sesi Anda sendiri dan tidak pernah di URL.
4. Kit pemain menggunakan token sampai mendekati waktu kedaluwarsanya, lalu meminta lagi ke server Anda. Lingara tidak pernah memperbarui token.

 player's device                your server                    Lingara
 ───────────────                ───────────                    ───────
 player kit ── needs a token ──▶ your token route
                                 server kit ── mint ─────────▶ token for one player
 player kit ◀── token, expiry ── your token route ◀──────────
 player kit ── API calls with the token ─────────────────────▶

Token untuk situs web terikat pada satu origin: skema, host, dan port milik halaman itu sendiri. Daftarkan setiap origin tempat widget Anda berjalan sebelum Anda mencetak token untuknya, seperti yang dijelaskan halaman kit server. Token untuk game tidak memiliki origin.

Apa yang dapat dilakukan token

Server Anda memilih scope setiap token saat mencetaknya, dari lima ini: events:read, events:write, lesson_plans:read, lesson_plans:write, dan embed:play. Token hanya dapat memegang scope yang sudah dimiliki klien Anda sendiri. embed:play memungkinkan pemain bercakap dengan karakter Anda dan melaporkan latihan yang mereka selesaikan.

Siapa yang membayar

Hanya klien pada paket berbasis meter yang dapat mencetak token. Semua yang dilakukan pemain dengan token dihitung sebagai penggunaan klien Anda dan ditagihkan kepada Anda, bukan kepada pemain.

Menghapus pemain

Saat pemain menghapus akun mereka di game Anda, server Anda juga menghapus mereka di Lingara. Itu menghapus pelajar mereka dan semua yang disimpan Lingara untuk mereka, serta mencabut setiap token yang mereka pegang.

Kit yang Anda butuhkan

Setiap integrasi menggunakan dua kit: kit server di server Anda, dan kit pemain di tempat pemain bermain.

Lalu baca dialog NPC dan hasil latihan, yang bekerja dengan cara yang sama di setiap kit.