Koppel 'n speler aan hul Lingara-rekening

API-weergawe 2026-10-virile-dragon

put https://api.getlingara.com/v1/embed/players/{player_ref}/link

Koppel een van jou spelers aan die Lingara-rekening wat pas aan jou app toegang gegee het. Roep dit met die gedelegeerde token wat jou bediener vir daardie rekening ontvang het, nooit met jou kliënt se eie token nie. Van dan af tree die speler se tokens as die rekening op, so ver as wat die toestemming toelaat: vra vir events:read, anders hoor jy niks oor die speler ná die koppeling nie. Afgehandelde planne skuif na die rekening; 'n plan wat nog geskryf word, bly totdat jy weer roep. Veilig om te herhaal: 'n herhaling antwoord existing en skuif wat voorheen nie kon skuif nie. Koppeling kos jou niks.

Omvange embed:play

Parameters

Lingara-Versionheaderstringopsioneel: Die API-weergawe waaronder hierdie versoek beantwoord word. Daarsonder kry 'n toegangstoken die weergawe waaraan sy kliënt gekoppel is, en 'n versoek sonder 'n token kry die huidige weergawe. Die weergawe wat nog ontwikkel word, is slegs bereikbaar deur dit hier te noem. 'n Onbekende weergawe gee 400 met kode api_version_unknown. GET /v1/versions lys die weergawes.
player_refpathstringverplig: Die player_ref waarmee jy die speler se tokens uitgereik het, persent-geënkodeer: guild/42 is guild%2F42.

Antwoorde

200 Die speler se koppeling

statusLinkStatusverplig
subjectstringverplig: Die rekening se lgr_sub_: wat hierdie speler se gebeure van nou af dra.
previous_subjectstringverplig: Die gas se lgr_sub_: wat die speler se vroeëre gebeure behou. Stuur albei na dieselfde player_ref.
linked_atstringverplig: Wanneer die koppeling gemaak is. By 'n existing-antwoord, die eerste oproep se tyd.
scopesarray of stringverplig: Die meeste wat 'n token vir hierdie speler nou kan hou: wat die rekening toegestaan het, van die bestekke wat 'n speler se token kan dra.
carriedobjectverplig: Rye wat hierdie oproep na die rekening geskuif het, per tabel. Slegs tabelle met 'n telling verskyn.
keptobjectverplig: Rye wat hierdie oproep by die gas gelaat het, per tabel: 'n plan wat nog geskryf word, of 'n ry wat die rekening reeds gehad het. Roep weer sodra lesson_plans hier 'n plan het wat klaar is.

Foute

402application/json: 'n Oproep van 'n gemeterde kliënt is geweier voordat dit iets bestee het. spend_cap_reached: die kliënt of sy rekening het sy maandelikse bestedingslimiet bereik; verhoog die limiet op die Integrasies-bladsy. metered_billing_inactive: gebruiksfakturering is nie aktief vir hierdie rekening nie; stel dit op, of werk die betaalmetode by, op die Integrasies-bladsy.
410application/json: Die API-weergawe waaronder hierdie versoek beantwoord word, is gestaak. Stuur 'n ondersteunde weergawe in Lingara-Version, of koppel die kliënt aan 'n ander weergawe.
4XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.
503application/json · text/plain: Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel.
5XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

codestringverplig: Waarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld insufficient_scope (403), rate_limited (429) en, vir 'n gemeterde kliënt, spend_cap_reached (402) en metered_billing_inactive (402).
errorstringverplig

Voorbeeld

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Verkies jy 'n biblioteek? Sien die Biblioteke-afdeling.

Indien 'n vertaling en die Engelse verwysing verskil, is die Engelse verwysing korrek.