Endpointsウィジェット
セッションアップグレードURLを生成する
iframeに表示するホスト型のセッションアップグレードウィジェットのURLを返します。 `/session/upgrade` で作成されたセッションアップグレードのチャレンジの保護者に提示し、新たに要求された権限を承認してもらいます。
Authorization
api-key AuthorizationBearer <token>
In: header
Request Body
application/json
セッションアップグレードURL生成リクエスト
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/widget/generate-session-upgrade-url" \ -H "Content-Type: application/json" \ -d '{ "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802", "email": "parent@example.com" }'{ "url": "https://family.k-id.com/widget", "shortUrl": "https://family.k-id.com/s/12345678-1234-1234-1234-123456789012?pid=42&s=qr"}保護者の同意URLを生成する POST
iframeに表示するホスト型の保護者同意ウィジェットのURLを返します。 既存のチャレンジの保護者に提示して同意を収集します。`/challenge/send-email` がリンクする体験と同じもので、リンクを自社で配信する場合に使用します。
ウィジェットステータスを取得する GET
エンドツーエンドまたは年齢ゲートウィジェットのフローの結果を、`/widget/generate-e2e-url` または `/widget/generate-age-gate-url` が返した `widgetId` をキーとして返します。 QRコードを読み取ったスマートフォンなど、プレイヤーが別のデバイスでフローを完了し、自社のサービスがその結果を必要とする場合に使用します。ウィジェットが一度 `PASS` を返すと、以降も `PASS` を返し続けます。続いて `/session/get` を呼び出し、セッションの現在の状態と権限を取得してください。結果をすぐに知る必要がある場合は、頻繁にポーリングするのではなくWebhookを購読してください。