自分
ログインした本人のことを扱う API。プロフィールの読み書きと充実度、自分の数字、ポートフォリオ、同意の記録、連携中のアプリ、アカウントの削除などがある。ヘッダに出す未読や得点のような軽い状態を読む入口もここにある。
この分類のあらまし
- 誰が呼べるか
ログインした本人が、自分の分だけを読み書きする。一部の画像を読む入口だけはログインなしで呼べる。
ログイン 35 件・認証なし 1 件
- 件数と印
この分類の API は 36 件・ポーリング 2 件・レート制限 12 件
画面が一定の間隔で呼び直す前提の API(ポーリング)。
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
自分
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API36 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- ヘッダ用の軽い状態(rev・未読通知・未読メッセージ・得点)GET取得
/api/me/pulseログイン・ポーリング - 自分のポートフォリオ(SPIKES Platform の作品)と連携の状態GET取得
/api/me/portfolioログイン - 自分のポートフォリオを丸ごと置き換える(expectedUpdatedAt が違えば 409 conflict と最新の current)PUT更新
/api/me/portfolioログイン - カバー 1 ファイル(画像 / 15 秒以内の動画 / 動画の表紙)を上げる許可と、ブラウザが直接上げる先POST作成・操作
/api/me/portfolio/uploadログイン・レート制限 - 上げたファイルを SPIKES が検証する(通れば作品の media に入れる値)POST作成・操作
/api/me/portfolio/upload/completeログイン・レート制限 - 旧 Bounty の作品(profile.portfolio)を SPIKES のポートフォリオへ 1 度だけ移す(本人の操作)POST作成・操作
/api/me/portfolio/migrateログイン - 18 歳以上の申告(BOUNTY が正本のときだけ。申告が無い人の作品は他の参加者に見せない。監査に残す)PUT更新
/api/me/portfolio/adultログイン - ポートフォリオのファイル(BOUNTY が正本のとき。本人と、作品を見られる参加者だけ。Range 対応・公開 URL は無い)GET取得
/api/portfolio/files/{userId}/{purpose}/{name}ログイン・レート制限 - 見た説明(説明シートを自動で開くのは 1 人 1 回)と、デモに出す数字GET取得
/api/me/explainersログイン - 説明を見たことにする(何度送っても最初の時刻のまま)POST作成・操作
/api/me/explainersログイン - 見た説明をすべて消す(初めての画面でまた自動で開く)DELETE削除
/api/me/explainersログイン - BOUNTY のアカウントと BOUNTY に保存したデータを消す(4S のアカウントは消さない)。アプリのトークンも使えなくなるPOST作成・操作
/api/me/account/deleteログイン・レート制限 - すべての端末からログアウト(この端末も含む。Web の cookie・アプリのトークンが使えなくなる)POST作成・操作
/api/me/sessions/revokeログイン・レート制限 - 本人の現在の参加表明HTML配置・公開版だけ(PNG生成なし)GET取得
/api/participation-visual/events/{eventId}/displayログイン - 本人の公開参加表明に使う顔写真・背景素材だけ(合成なし)GET取得
/api/participation-visual/events/{eventId}/display-imageログイン - 本人の現在のイベント別データで PNG を生成(参加登録は作らない)POST作成・操作
/api/participation-visual/events/{eventId}/renderログイン・レート制限 - 本人のイベント別needsがある時に投稿案内を一回だけ claimPOST作成・操作
/api/participation-visual/events/{eventId}/promptログイン・レート制限 - おすすめの人を探すジョブを始める(同じ条件の実行中ジョブがあれば 200 で再利用)POST作成・操作
/api/ai/jobsログイン・レート制限 - おすすめジョブの状態と結果(ランク別)GET取得
/api/ai/jobs/{id}ログイン・ポーリング - 自分の最新のおすすめジョブ(無ければ job が null)GET取得
/api/ai/jobs/latestログイン - プロフィールや投稿などの内容を運営に通報するPOST作成・操作
/api/content/reportsログイン・レート制限 - 確認済みの画像・動画を読む(本人の確認待ちと運営の審査を含む。Range に対応。部分は 206)GET取得
/api/content/assets/{id}認証なし(任意) - 掲載されなかった自分の内容に異議を送るPOST作成・操作
/api/me/content/{id}/appealログイン - 選べる属性ラベルの一覧(カテゴリと、その中のラベル)GET取得
/api/labelsログイン - 利用目的への同意・取り消しを記録するPOST作成・操作
/api/me/consentログイン・レート制限 - 4S の参加登録(会場受付の有無)を読み直す(1 分に 1 回まで)POST作成・操作
/api/me/fours-entryログイン・レート制限 - 最初のログインで「以前、別の方法でログインしていませんか?」を出すか(相手のアカウントのことは返さない)GET取得
/api/me/returning-personログイン - 「以前、別の方法でログインしていませんか?」への本人の選択を 1 度だけ残す(relogin / dismissed。アカウントはまとめない)POST作成・操作
/api/me/returning-personログイン - 4S からプロフィールを取り込み直す(連携が無ければ理由を返す)POST作成・操作
/api/me/fours-syncログイン - 連携中のアプリ(MCP の接続の許可)GET取得
/api/me/oauth-grantsログイン - 連携中のアプリを解除する(すぐに使えなくなる)DELETE削除
/api/me/oauth-grants/{id}ログイン - 作品のリンクから題名・説明・カバー画像を読む(https だけ)POST作成・操作
/api/me/portfolio/previewログイン・レート制限 - 自分のプロフィール(編集用)と充実度GET取得
/api/me/profileログイン・応答の詳細は準備中 - プロフィールを更新する(省いた項目は変えない。充実度の前後と加点を返す)PATCH一部を更新
/api/me/profileログイン・応答の詳細は準備中 - プロフィールの必須項目がそろっているか(足りなければ編集用の値も返す)GET取得
/api/me/profile-completionログイン・応答の詳細は準備中 - 自分の数字(得点・称号・会った人数・マッチ・チェックイン・WANTED・受けた会いたい)GET取得
/api/me/statsログイン