Incorporar o Lingara

Esta página é uma tradução do inglês. Se as duas diferirem, a página em inglês é a correta. Ler a página em inglês

O Lingara pode viver dentro do seu jogo ou do seu site. Uma personagem do seu mundo pode manter uma conversa ao nível do jogador, e a prática que o seu jogador termina conta como prática do Lingara. A integração tem duas metades, e a primeira coisa a decidir é qual das metades é executada onde.

Quem guarda o quê

O seu servidor guarda o segredo do seu cliente OAuth e o seu segredo de assinatura de webhooks. Nenhum deles sai alguma vez de lá.

O dispositivo do jogador guarda uma única coisa: um token de integração, que começa por lgr_et_. Tudo o que distribui dentro de um binário de jogo ou de uma página web é público, pelo que o dispositivo nunca guarda um segredo de cliente, um segredo de webhook nem um token de acesso do seu próprio cliente. Um token de integração age apenas em nome de um jogador, dura minutos em vez de horas e contém apenas os scopes que o seu servidor lhe deu.

Um jogador não precisa de conta Lingara. O primeiro token que o seu servidor emite para um jogador cria para ele um aprendente convidado, e cada token posterior chega ao mesmo aprendente. Um jogador que já tenha uma conta Lingara pode trazê-la: a página kits de servidor descreve como o seu servidor liga as duas.

Como um token chega ao jogador

1. O kit de jogador, no seu jogo ou na sua página, precisa de um token e pede-o ao seu servidor através da sua fonte de tokens.
2. O seu servidor verifica a sua própria sessão para esse jogador e emite um token para ele com o kit de servidor.
3. O seu servidor devolve o token em dois campos, o token e a sua validade, através da sua própria sessão e nunca num URL.
4. O kit de jogador usa o token até se aproximar da sua validade e, depois, volta a pedir ao seu servidor. O Lingara nunca renova um 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 ─────────────────────▶

Um token para um site está associado a uma única origem: o esquema, o anfitrião e a porta da própria página. Registe cada origem em que o seu widget é executado antes de emitir tokens para ela, como descreve a página kits de servidor. Um token para um jogo não tem origem.

O que um token pode fazer

O seu servidor escolhe os scopes de cada token quando o emite, de entre estes cinco: events:read, events:write, lesson_plans:read, lesson_plans:write e embed:play. Um token só pode conter scopes que o seu próprio cliente já tem. embed:play permite ao jogador manter conversas com as suas personagens e comunicar a prática que termina.

Quem paga

Só um cliente no plano por utilização pode emitir tokens. Tudo o que um jogador faz com um token é contabilizado como utilização do seu cliente e faturado a si, não ao jogador.

Eliminar um jogador

Quando um jogador elimina a sua conta no seu jogo, o seu servidor elimina-o também no Lingara. Isso remove o aprendente dele e tudo o que o Lingara guarda sobre ele, e revoga todos os tokens que ele tem.

De que kit precisa

Cada integração usa dois kits: um kit de servidor no seu servidor e um kit de jogador onde o jogador joga.

Depois, leia Diálogo com NPC e resultados da prática, que funcionam da mesma forma em todos os kits.