POST/api/qr/meet
「QR」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
相手の QR(Bounty の署名付き QR か 4S One QR)を読み取ってミートを記録する。Bounty 外の人は external_contact に記録
- 呼び方と印
ログイン・レート制限
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
|1必須objecttoken必須string長さ 8–160 · /^[A-Za-z0-9_.-]+$/|2必須objectoneQr必須objectslug必須string/^[A-Za-z0-9_-]{1,64}$/token必須string/^[A-Za-z0-9_-]{16,128}$/context任意string長さ ≤850shareWithBooth任意booleanshareWithCompany任意booleanexpectedActorId任意string(uuid)recipientVersion任意string/^[a-f0-9]{64}$/
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
|1objectkind"company_contact"companyobjectidstringnamestring
sharedbooleanmeetRecordedfalse
|2objectcreatedbooleanpointsnumberpointsEachnumberbountynumberotherobjectidstringdisplayNamestringavatarUrlstring | nulltitlestring | nullorgNamestring | nullcatchphrasestring | nullwantedobject | nullbountynumber
kind"meet"
|3objectkind"sponsor"personobjectdisplayNamestringavatarUrlstring | nulltitlestring | nullorgNamestring | nullslugstringprofileUrlstring | null
sponsorobjectidstringnamestring
|4objectkind"invite"personobjectdisplayNamestringavatarUrlstring | nulltitlestring | nullorgNamestring | nullslugstringprofileUrlstring | null
sponsornull
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- 429レート制限(Retry-After 付き)
- qr_expired
- unknown_token
- own_token
- invalid_qr
- invalid_company_qr
- rate_limited
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/qr/meet" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{
"token": "string"
}'