Integrar Lingara

Esta página está traducida del inglés. Si ambas difieren, la página en inglés es la correcta. Leer la página en inglés

Lingara puede vivir dentro de tu juego o de tu sitio web. Un personaje de tu mundo puede mantener una conversación al nivel del jugador, y la práctica que termina tu jugador cuenta como práctica de Lingara. La integración tiene dos mitades, y lo primero que hay que decidir es qué mitad se ejecuta dónde.

Quién guarda qué

Tu servidor guarda el secreto de tu cliente OAuth y tu secreto de firma de webhooks. Ninguno de los dos sale nunca de él.

El dispositivo del jugador guarda una sola cosa: un token de integración, que empieza por lgr_et_. Todo lo que distribuyes dentro del binario de un juego o de una página web es público, así que el dispositivo nunca guarda un secreto de cliente, un secreto de webhook ni un token de acceso de tu propio cliente. Un token de integración actúa solo para un jugador, dura minutos en lugar de horas y solo tiene los scopes que le ha dado tu servidor.

Un jugador no necesita una cuenta de Lingara. El primer token que tu servidor emite para un jugador crea para él un aprendiz invitado, y cada token posterior llega al mismo aprendiz. Un jugador que ya tiene una cuenta de Lingara puede traerla: la página de kits de servidor describe cómo vincula tu servidor las dos.

Cómo llega un token al jugador

1. El kit de jugador, en tu juego o en tu página, necesita un token y se lo pide a tu servidor a través de su fuente de tokens.
2. Tu servidor comprueba su propia sesión para ese jugador y emite un token para él con el kit de servidor.
3. Tu servidor devuelve el token como dos campos, el token y su caducidad, a través de tu propia sesión y nunca en una URL.
4. El kit de jugador usa el token hasta que se acerca su caducidad y entonces vuelve a pedírselo a tu servidor. Lingara nunca renueva 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 para un sitio web está vinculado a un único origen: el esquema, el host y el puerto propios de la página. Registra cada origen en el que se ejecute tu widget antes de emitir tokens para él, como describe la página de kits de servidor. Un token para un juego no tiene origen.

Qué puede hacer un token

Tu servidor elige los scopes de cada token al emitirlo, entre estos cinco: events:read, events:write, lesson_plans:read, lesson_plans:write y embed:play. Un token solo puede tener scopes que tu propio cliente ya tiene. embed:play permite al jugador mantener conversaciones con tus personajes e informar de la práctica que termina.

Quién paga

Solo un cliente con el plan por consumo puede emitir tokens. Todo lo que hace un jugador con un token cuenta como uso de tu cliente y se te factura a ti, no al jugador.

Eliminar a un jugador

Cuando un jugador elimina su cuenta en tu juego, tu servidor también lo elimina en Lingara. Eso elimina su aprendiz y todo lo que Lingara guarda de él, y revoca cada token que tiene.

Qué kit necesitas

Cada integración usa dos kits: un kit de servidor en tu servidor y un kit de jugador donde juega el jugador.

Después lee Diálogo con PNJ y resultados de práctica, que funcionan igual en todos los kits.