Endpointsチャレンジ
保護者招待チャレンジを作成する
`sessionId` に紐づく保護者招待チャレンジを作成し、`parentEmail` に招待メールを送信します。利用できるのは、保護者の同意が不要で、かつセッションがまだ保護者と連携されていないプレイヤーのみです。それ以外のセッションは拒否されます（以下のエラーコードを参照）。PASS になると、同じ `sessionId` を伴って `Challenge.StateChange` が発火するため、結果をこの招待と対応付けられます。
Authorization
api-key AuthorizationBearer <token>
In: header
Request Body
application/json
Invite parent request
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/challenge/invite-parent" \ -H "Content-Type: application/json" \ -d '{ "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672", "parentEmail": "parent@example.com", "playerName": "Alex", "locale": "en" }'{ "status": "CHALLENGE", "challenge": { "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802", "type": "CHALLENGE_PARENT_INVITE" }}{ "error": "INVALID_INPUT", "errorMessage": "The request was missing a sessionId parameter."}チャレンジを取得する GET
既存のチャレンジを返します。 チャレンジが成功または失敗した後は `oneTimePassword` と `url` は含まれません。再提示する必要がある場合は、チャレンジが有効な間に取得しておいてください。
決済確認を添えてメールを送信する POST
保護者への同意リクエストをメールで送信する際に、その背後にある購入について成人がすでに決済を完了したというアテステーションを添えます。 `paymentVerification` が必須である点を除き、`/challenge/send-email` と同じです。添えるべき決済がない場合は、そちらのAPIを使用してください。このアテステーションは、組織でTransactions機能が有効になっている場合にのみ読み取られ、それ以外の場合は無視されます。