本文へ移動
Bounty Developer

GET/api/notifications

「通知」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

通知の一覧（?filter=unread・?before=<nextBefore>・?limit=。各項目に東京時間の日付の区切り group）

呼び方と印

ログイン・ポーリング

画面が一定の間隔で呼び直す前提の API（ポーリング）。

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

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

  • filterquery任意"all" | "unread"
    既定 "all"
  • beforequery任意string
    長さ 20–80
  • limitquery任意integer
    1–100

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

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

  • revinteger
  • unreadinteger
  • notificationsUnreadinteger
  • itemsarray<object>
    • idstring
    • kindstring
    • titlestring
    • bodystring | null
    • hrefstring | null
    • readboolean
    • createdAtstring
    • group"today" | "yesterday" | "earlier"
  • nextBeforestring | null

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/notifications" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/notifications | Bounty Developer