コンソールとQRコードのフロー向けのウィジェットIDとウィジェットステータス
エンドツーエンドウィジェットと年齢ゲートウィジェットがwidgetIdを返すようになりました。これにより、コンソールに表示されたQRコードをスキャンしたスマートフォンなど、プレイヤーが別のデバイスで完了したフローの結果をサーバーで取得できます。これまで、この結果はDOMイベントかリダイレクトでしか返されず、コンソールはどちらも受け取れませんでした。
新機能
- ウィジェットURLのレスポンスに
widgetId。/widget/generate-e2e-urlと/widget/generate-age-gate-urlが、urlとshortUrlに加えてwidgetIdを返します。プレイヤーと紐づけて保存してください。 - ウィジェットステータスのエンドポイント。
GET /widget/get-statusは1件のウィジェットの結果を返します:PENDING、PASS、IN_CHALLENGE、FAILED、PROHIBITED、EXPIRED。POST /widget/get-statusは一度に最大100件のウィジェットを読み取ります。一度PASSになったウィジェットは、その後もPASSを返し続けます。 Challenge.StateChangeにwidgetId。 これらのウィジェットから開始したチャレンジでは、WebhookにwidgetIdが含まれるようになりました。
互換性
すべての変更は追加のみで、既存のフィールドの意味は変わりません。OpenAPI仕様からクライアントを生成している場合、/widget/generate-e2e-urlと/widget/generate-age-gate-urlのレスポンス型はそれぞれGenerateE2EUrlResponseとGenerateAgeGateUrlResponseという名前になり、従来の形にwidgetIdが追加されます。
ドキュメント
- サーバーでウィジェットの結果を取得する: ステータス、ポーリング、Webhook。
Challenge.StateChangeイベントリファレンス