本文へ移動
Bounty Developer

GET/api/me/portfolio

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

要約

自分のポートフォリオ(SPIKES Platform の作品)と連携の状態

呼び方と印

ログイン

返るもの(応答)200 · application/json

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

  • stateenum(5)"ready" "link_required" "deleted" "unavailable" "off"
  • items任意array<object>
    • idstring
    • kindenum(7)"video" "image" "project" "article" "achievement" "event" "link"
    • titlestring
    • descriptionstring
    • urlstring
    • coverUrlstring
    • role任意string
    • year任意integer
    • tags任意array<string>
    • media任意object
      • kind"image" | "video"
      • urlstring
      • posterUrl任意string
      • durationSec任意number
      • width任意integer
      • height任意integer
    • entryType任意"work" | "lightning_talk"
    • format任意enum(14)"video" "animation" "photography" "image" "graphic" "audio" "music" "writing" "product" "software" "game" "hardware" …+2
    • tools任意array<string>
    • technicalDetails任意record<array<string>>
    • technicalNote任意string
    • attachment任意object
      • kind"pdf"
      • urlstring
  • updatedAt任意string | null
  • publicUrl任意string | null
  • reason任意"not_linked" | "link_requires_spikes_login" | "account_conflict"
  • spikesUrl任意string
  • legacyCountinteger
  • fixture任意boolean
  • adultDeclared任意boolean

失敗したとき(エラー)

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

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

呼び出しの見本

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

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