POST/api/meets/requests
「出会い」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
出会いましょう / いまから行ける? を送る(同じ 2 人の間で動いている依頼があれば 200 でそれを返す)
- 呼び方と印
ログイン・レート制限
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
kind必須"plan" | "now"meetingMode任意"onsite" | "online"既定 "onsite"spotId任意string(uuid) | nullmapPin任意object | nullmapId必須string(uuid)x必須number0–1y必須number0–1label必須string長さ 1–60meetingPlaceId任意string(uuid) | nullplaceText任意string | null長さ ≤60proposedAt任意string(date-time) | nullmessage任意string | null長さ ≤200toUserId必須string(uuid)strong任意boolean
返るもの(応答)201 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
idstringexistingboolean
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- 429レート制限(Retry-After 付き)
- invalid_input
- self
- not_related
- user_not_found
- unknown_spot
- unknown_map
- stale_map
- place_required
- time_required
- time_in_past
- time_too_far
- rate_limited
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/meets/requests" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{
"kind": "plan",
"toUserId": "00000000-0000-4000-8000-000000000000"
}'