本文へ移動
Bounty Developer

POST/api/passes/{eventId}/nfc/prepare

「QR」の分類の、新しく作る、または操作を実行するために内容を送る API。ブラウザでログインした本人（cookie）として呼ぶ。

要約

cookie本人だけが確認済みNFCパスの書込みを準備（他人ID・PAT不可）

呼び方と印

ログイン（cookie）

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • eventIdpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • templateRevision必須integer
    0–2147483646
  • draftRevision必須integer
    0–2147483646
  • requestKey必須string(uuid)

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • operationIdstring(uuid)
  • urlstring長さ 1–2048
  • expiresAtstring(date-time)
  • templateRevisioninteger0–2147483646
  • draftRevisioninteger0–2147483646

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 502HTTP 502（x-bounty-error-codes を参照）
  • invalid_origin
  • pass_human_action_required
  • pass_ticket_required
  • pass_confirm_required
  • pass_revision_conflict
  • consent_required
  • fours_entry_unavailable

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X POST "https://bounty.spikes.4s.link/api/passes/{eventId}/nfc/prepare" \
  -b "bounty_session=$COOKIE_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "templateRevision": 0,
    "draftRevision": 0,
    "requestKey": "00000000-0000-4000-8000-000000000000"
  }'
POST /api/passes/{eventId}/nfc/prepare | Bounty Developer