本文へ移動
Bounty Developer

POST/api/events/{slug}/qr/meet

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

要約

同イベントの現在の参加資格と本物のQRを照合して交換実績・由来を記録

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • slugpath必須string

送るもの（本文）application/json

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

  • |1必須object
  • token必須string
    長さ 8–160 · /^[A-Za-z0-9_.-]+$/
  • expectedEventId必須string(uuid)
  • expectedActorId必須string(uuid)
  • expectedRevision必須string
    /^[a-f0-9]{64}$/
  • |2必須object
  • oneQr必須object
  • slug必須string
    /^[A-Za-z0-9_-]{1,64}$/
  • token必須string
    /^[A-Za-z0-9_-]{16,128}$/
  • context任意string
    長さ ≤850
  • shareWithBooth任意boolean
  • shareWithCompany任意boolean
  • expectedActorId必須string(uuid)
  • recipientVersion任意string
    /^[a-f0-9]{64}$/
  • expectedEventId必須string(uuid)
  • expectedRevision必須string
    /^[a-f0-9]{64}$/

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

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

  • |1object
    • kind"company_contact"
    • companyobject
      • idstring
      • namestring
    • sharedboolean
    • meetRecordedfalse
    • eventIdstring(uuid)
    • actorIdstring(uuid)
    • eventRevisionstring/^[a-f0-9]{64}$/
  • |2object
    • createdboolean
    • pointsnumber
    • pointsEachnumber
    • bountynumber
    • otherobject
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • catchphrasestring | null
      • wantedobject | null
        • bountynumber
    • kind"meet"
    • eventIdstring(uuid)
    • actorIdstring(uuid)
    • eventRevisionstring/^[a-f0-9]{64}$/
  • |3object
    • kind"sponsor"
    • personobject
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • slugstring
      • profileUrlstring | null
    • sponsorobject
      • idstring
      • namestring
    • eventIdstring(uuid)
    • actorIdstring(uuid)
    • eventRevisionstring/^[a-f0-9]{64}$/
  • |4object
    • kind"invite"
    • personobject
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • slugstring
      • profileUrlstring | null
    • sponsornull
    • eventIdstring(uuid)
    • actorIdstring(uuid)
    • eventRevisionstring/^[a-f0-9]{64}$/

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 410HTTP 410（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/events/{slug}/qr/meet" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string",
    "expectedEventId": "00000000-0000-4000-8000-000000000000",
    "expectedActorId": "00000000-0000-4000-8000-000000000000",
    "expectedRevision": "string"
  }'
POST /api/events/{slug}/qr/meet | Bounty Developer