Membenamkan Lingara

Halaman ini diterjemahkan daripada bahasa Inggeris. Jika kedua-duanya berbeza, halaman bahasa Inggeris adalah yang betul. Baca halaman bahasa Inggeris

Lingara boleh tinggal di dalam permainan atau laman web anda. Watak dalam dunia anda boleh bercakap pada tahap pemain, dan latihan yang diselesaikan oleh pemain anda dikira sebagai latihan Lingara. Benaman ini mempunyai dua bahagian, dan perkara pertama yang perlu ditentukan ialah bahagian mana yang berjalan di mana.

Siapa yang memegang apa

Pelayan anda memegang rahsia klien OAuth anda dan rahsia tandatangan webhook anda. Kedua-duanya tidak pernah meninggalkannya.

Peranti pemain memegang satu perkara: token benaman, yang bermula dengan lgr_et_. Apa sahaja yang anda hantar di dalam binari permainan atau halaman web adalah awam, jadi peranti tidak pernah memegang rahsia klien, rahsia webhook atau token akses klien anda sendiri. Token benaman bertindak untuk seorang pemain sahaja, bertahan beberapa minit dan bukannya beberapa jam, dan hanya memegang skop yang diberikan oleh pelayan anda.

Pemain tidak memerlukan akaun Lingara. Token pertama yang dicetak oleh pelayan anda untuk seorang pemain mencipta pelajar tetamu untuk mereka, dan setiap token selepas itu sampai kepada pelajar yang sama. Pemain yang sudah mempunyai akaun Lingara boleh membawanya: halaman kit pelayan menerangkan cara pelayan anda memautkan kedua-duanya.

Cara token sampai kepada pemain

1. Kit pemain, dalam permainan anda atau pada halaman anda, memerlukan token dan meminta daripada pelayan anda melalui sumber tokennya.
2. Pelayan anda menyemak sesinya sendiri untuk pemain itu dan mencetak token untuk mereka dengan kit pelayan.
3. Pelayan anda menyerahkan token kembali sebagai dua medan, token dan tempoh tamatnya, melalui sesi anda sendiri dan tidak pernah dalam URL.
4. Kit pemain menggunakan token sehingga ia hampir tamat tempoh, kemudian meminta daripada pelayan anda sekali lagi. Lingara tidak pernah memperbaharui 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 laman web terikat kepada satu asalan: skema, hos dan port halaman itu sendiri. Daftarkan setiap asalan tempat widget anda berjalan sebelum anda mencetak untuknya, seperti yang diterangkan pada halaman kit pelayan. Token untuk permainan tidak mempunyai asalan.

Apa yang boleh dilakukan oleh token

Pelayan anda memilih skop setiap token semasa mencetaknya, daripada lima ini: events:read, events:write, lesson_plans:read, lesson_plans:write dan embed:play. Token hanya boleh memegang skop yang sudah dipegang oleh klien anda sendiri. embed:play membolehkan pemain bercakap dengan watak anda dan melaporkan latihan yang mereka selesaikan.

Siapa yang membayar

Hanya klien pada pelan bermeter boleh mencetak token. Semua yang dilakukan pemain dengan token dikira sebagai penggunaan klien anda dan dibilkan kepada anda, bukan kepada pemain.

Memadam pemain

Apabila pemain memadam akaun mereka dalam permainan anda, pelayan anda turut memadam mereka di Lingara. Ini membuang pelajar mereka dan semua yang disimpan oleh Lingara untuk mereka, serta membatalkan setiap token yang mereka pegang.

Kit yang anda perlukan

Setiap integrasi menggunakan dua kit: kit pelayan pada pelayan anda, dan kit pemain di tempat pemain bermain.

Kemudian baca dialog NPC dan hasil latihan, yang berfungsi dengan cara yang sama dalam setiap kit.