プレイヤーのトークンを発行

パラメーター

Lingara-Versionheaderstring任意

このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

リクエスト本文 application/json

player_refstring必須

プレイヤーに対する独自の参照：制御文字を含まない1〜128バイトのUTF-8。Lingaraが保存するのはそのハッシュだけです。

scopesarray of string | null任意

originstring | null任意

レスポンス

200 プレイヤーのトークン

tokenstring必須

expires_atstring必須

expires_ininteger必須

この応答からトークンの期限が切れるまでの秒数。デバイスの時計が信頼できない場合に使います。

subjectstring必須

scopesarray of string必須

account_linkedboolean必須

エラー

410application/json

このリクエストに応答する API バージョンは提供を終了しました。Lingara-Version でサポート対象のバージョンを送るか、クライアントを別のバージョンに固定し直してください。

4XXapplication/json

リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。

503application/json · text/plain

サービスは一時的に利用できません。Retry-After に示された秒数が経過してから再試行してください。メンテナンス中は、本文はエラーエンベロープではなくプレーンテキストになります。

5XXapplication/json

リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。

codestring必須

リクエストが拒否された理由を、分岐に使える安定したコードで示します。例：insufficient_scope（403）、rate_limited（429）、従量課金クライアントの場合は spend_cap_reached（402）と metered_billing_inactive（402）。

errorstring必須

例

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"}'

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。