本文へ移動
Bounty Developer

GET/api/me/referral/renderer

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

要約

自分の紹介の木を描くための公開項目（参加登録・上の代・下の代）

呼び方と印

ログイン・応答の詳細は準備中

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

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

  • operationquery必須"entries" | "ancestors" | "descendants"
  • anchorEntryIdquery任意string(uuid)
  • targetEntryIdquery任意string(uuid)
  • generationsquery任意integer
    1–10 · 既定 10
  • childrenLimitquery任意integer
    1–20 · 既定 20
  • cursorquery任意string
    /^[A-Za-z0-9_-]{1,2048}$/

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

応答の詳細は準備中

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403権限が無い
  • 502HTTP 502（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • invalid_input
  • referral_tree_not_owned
  • referral_participation_required
  • referral_cursor_invalid
  • referral_not_configured
  • fours_reconnect_required
  • referral_unavailable

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/me/referral/renderer?operation=entries" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/me/referral/renderer | Bounty Developer