Myönnä pelaajalle tunnus

API-versio 2026-10-virile-dragon

post https://api.getlingara.com/v1/embed/tokens

Takaa yhden pelaajistasi ja palauttaa tunnuksen, jota pelisi tai sivusi käyttää hänen puolestaan 15 minuuttia. Ensimmäinen tunnus player_ref-arvolle luo pelaajalle oppijan; myöhemmät käyttävät sitä uudelleen. Pyydä uusi, kun tunnus vanhenee; sitä ei koskaan uusita. Vaatii metered-asiakkaan.

Oikeuslaajuudet embed:mint

Parametrit

Lingara-Versionheaderstringvalinnainen: API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan 400 koodilla api_version_unknown. GET /v1/versions luettelee versiot.

Pyynnön runko `application/json`

player_refstringpakollinen: Oma viitteesi pelaajaan: 1–128 tavua UTF-8:aa ilman ohjausmerkkejä. Lingara tallentaa siitä vain tiivisteen.
scopesarray of string | nullvalinnainen
originstring | nullvalinnainen

Vastaukset

200 Pelaajan tunnus

tokenstringpakollinen
expires_atstringpakollinen
expires_inintegerpakollinen: Sekunnit tunnuksen vanhenemiseen tästä vastauksesta laskien. Käytä tätä, kun laitteen kelloon ei voi luottaa.
subjectstringpakollinen
scopesarray of stringpakollinen
account_linkedbooleanpakollinen

Virheet

410application/json: API-versio, jolla tähän pyyntöön vastataan, on lopetettu. Lähetä tuettu versio Lingara-Version-otsakkeessa tai kiinnitä asiakas toiseen versioon.
4XXapplication/json: Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.
503application/json · text/plain: Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan.
5XXapplication/json: Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

codestringpakollinen: Miksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi insufficient_scope (403), rate_limited (429) ja käytön mukaan laskutettavalle asiakkaalle spend_cap_reached (402) ja metered_billing_inactive (402).
errorstringpakollinen

Esimerkki

curl -X POST "https://api.getlingara.com/v1/embed/tokens" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"player_ref":"player-1001","scopes":["embed:play","lesson_plans:read","lesson_plans:write"],"origin":"https://game.example.com"}'

Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.