POST/api/passes/{eventId}/nfc/complete
「QR」の分類の、新しく作る、または操作を実行するために内容を送る API。ブラウザでログインした本人(cookie)として呼ぶ。
- 要約
cookie本人の同tag読み戻しを検査して書込み完了記録(入場なし)
- 呼び方と印
ログイン(cookie)
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
eventIdpath必須string(uuid)
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
operationId必須string(uuid)platform必須"ios" | "android"capacityBytes必須integer1–1048576ndefBytes必須integer1–4096readbackUrl必須string長さ 1–2048tagHash必須string/^[0-9a-f]{64}$/overwriteConfirmed任意boolean既定 falseoverwriteFingerprint任意string/^[0-9a-f]{64}$/
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
status"verified"operationIdstring(uuid)verifiedAtstring(date-time)templateRevisioninteger0–2147483646draftRevisioninteger0–2147483646platform"ios" | "android"profileUserId任意string(uuid)
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- 404HTTP 404(x-bounty-error-codes を参照)
- 409HTTP 409(x-bounty-error-codes を参照)
- 422HTTP 422(x-bounty-error-codes を参照)
- 428HTTP 428(x-bounty-error-codes を参照)
- 502HTTP 502(x-bounty-error-codes を参照)
- invalid_origin
- pass_human_action_required
- pass_ticket_required
- pass_nfc_operation_expired
- pass_revision_conflict
- consent_required
- fours_entry_unavailable
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/passes/{eventId}/nfc/complete" \
-b "bounty_session=$COOKIE_AUTH" \
-H "Content-Type: application/json" \
-d '{
"operationId": "00000000-0000-4000-8000-000000000000",
"platform": "ios",
"capacityBytes": 1,
"ndefBytes": 1,
"readbackUrl": "string",
"tagHash": "string"
}'