Incorporare Lingara

Questa pagina è tradotta dall'inglese. Se le due versioni differiscono, fa fede la pagina in inglese. Leggi la pagina in inglese

Lingara può vivere dentro il tuo gioco o il tuo sito web. Un personaggio del tuo mondo può sostenere una conversazione al livello del giocatore, e la pratica che il giocatore completa conta come pratica Lingara. L’integrazione ha due metà, e la prima cosa da stabilire è quale metà viene eseguita dove.

Chi conserva cosa

Il tuo server conserva il segreto del tuo client OAuth e il segreto di firma dei tuoi webhook. Nessuno dei due lo lascia mai.

Il dispositivo del giocatore conserva una sola cosa: un token di embed, che inizia con lgr_et_. Tutto ciò che distribuisci dentro il binario di un gioco o una pagina web è pubblico, quindi il dispositivo non conserva mai un segreto client, un segreto webhook o un token di accesso del tuo client. Un token di embed agisce per un solo giocatore, dura minuti anziché ore e contiene solo gli scope che il tuo server gli ha assegnato.

Un giocatore non ha bisogno di un account Lingara. Il primo token che il tuo server emette per un giocatore crea per lui uno studente ospite, e ogni token successivo raggiunge lo stesso studente. Un giocatore che ha già un account Lingara può portarlo con sé: la pagina dei kit server descrive come il tuo server collega i due.

Come un token raggiunge il giocatore

1. Il player kit, nel tuo gioco o nella tua pagina, ha bisogno di un token e lo chiede al tuo server tramite la sua fonte di token.
2. Il tuo server verifica la propria sessione per quel giocatore ed emette un token per lui con il kit server.
3. Il tuo server restituisce il token come due campi, il token e la sua scadenza, tramite la tua sessione e mai in un URL.
4. Il player kit usa il token finché non si avvicina alla scadenza, poi lo chiede di nuovo al tuo server. Lingara non rinnova mai un 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 ─────────────────────▶

Un token per un sito web è vincolato a una sola origine: lo schema, l’host e la porta della pagina stessa. Registra ogni origine su cui gira il tuo widget prima di emettere token per essa, come descrive la pagina dei kit server. Un token per un gioco non ha origine.

Cosa può fare un token

Il tuo server sceglie gli scope di ogni token quando lo emette, tra questi cinque: events:read, events:write, lesson_plans:read, lesson_plans:write ed embed:play. Un token può contenere solo scope che il tuo client possiede già. embed:play consente al giocatore di conversare con i tuoi personaggi e di segnalare la pratica che completa.

Chi paga

Solo un client con il piano a consumo può emettere token. Tutto ciò che un giocatore fa con un token viene conteggiato come utilizzo del tuo client e addebitato a te, non al giocatore.

Eliminare un giocatore

Quando un giocatore elimina il proprio account nel tuo gioco, il tuo server lo elimina anche su Lingara. Questo rimuove il suo studente e tutto ciò che Lingara conserva per lui, e revoca ogni token in suo possesso.

Di quale kit hai bisogno

Ogni integrazione usa due kit: un kit server sul tuo server e un player kit dove il giocatore gioca.

Poi leggi Dialoghi con gli NPC e risultati della pratica, che funzionano allo stesso modo in ogni kit.