BOSHU の外部 API
募集を外から組み立てるための API。募集を作れる主体を確かめ、保存と同じ判定で設計を検証してから下書きとして保存し、質問のページを操作の列で組む。パートナー募集への団体での申し込みと、公開の団体・パートナーの一覧もここにある。
この分類のあらまし
- 誰が呼べるか
下書きの入口はログインして呼び、作れる募集は呼ぶ人の権限で決まる。公開の団体・パートナーの一覧と公開中のフォームはログインなしで読める。
ログイン 12 件・認証なし 4 件
- 件数と印
この分類の API は 16 件・レート制限 12 件
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
募集の外部 API(運営の API トークン)
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API16 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 公開承認済み団体の紹介のみ(人物・連絡先なし)。kindとcursorで各種類最大500件、nextCursorで継続GET取得
/api/public/orgs認証なし - 主のイベントのパートナー(ロゴ掲載の段以上)の名前・ロゴ・段・ポイントだけ(件数の内訳・上書きの理由・人物は出さない)GET取得
/api/public/partners認証なし - 下書き投入の前提: 募集を作れる主体・紐づくイベント(null = 紐づかない)・テンプレートと既定の質問/対象/入力設定/主体の制限(partner=イベントのパートナーBOSHU)・上限GET取得
/api/v1/boshu/drafts/contextログイン・レート制限 - 呼び手が今扱える既存の募集(重複の確認用。状態・主体・イベント・質問の版・件数。応募者の情報なし)GET取得
/api/v1/boshu/drafts/referenceログイン・レート制限 - 募集の設計を保存と同じ判定で検証・正規化する(書込みなし)POST作成・操作
/api/v1/boshu/drafts/previewログイン・レート制限 - 募集の下書きを作る / 直す(sourceKey・idempotencyKey・expectedHash。常に下書き。公開・承認・通知なし。作成 201 / 更新・再送 200)POST作成・操作
/api/v1/boshu/draftsログイン・レート制限 - 1 つの募集の設計・質問の組・版の hash の読み戻し(今扱える募集だけ。応募者の情報は件数だけ)GET取得
/api/v1/boshu/drafts/{id}ログイン・レート制限 - 置ける共通モジュールの棚(全イベント共通 + callId の募集のイベント、または eventId のイベント(イベントの管理者以上)。行き先に募集を含むものだけ)GET取得
/api/v1/boshu/form-modulesログイン・レート制限 - 募集の設問(ページ・モジュール・質問・固定した revision・棚の新しい版の有無・hash・MCP で当てられる範囲)。応募者の情報は件数だけGET取得
/api/v1/boshu/calls/{id}/questionnaireログイン・レート制限 - 操作の列を保存と同じ関数で当てて必ず巻き戻す(版が増えるか・再承認になるか・当てた後の設問。書込み・監査なし)POST作成・操作
/api/v1/boshu/calls/{id}/questionnaire/previewログイン・レート制限 - 操作の列を 1 つの transaction で当てる(下書きは全部・公開中と締切済みは版が増えない操作だけ。公開の状態は変えない)POST作成・操作
/api/v1/boshu/calls/{id}/questionnaire/applyログイン・レート制限 - 質問の無い募集の下書きを作り、同じ transaction でモジュールの操作を当てる(sourceKey・idempotencyKey。常に下書き)POST作成・操作
/api/v1/boshu/drafts/from-modulesログイン・レート制限 - イベントの公開中の団体フォーム(パートナー登録 = a+b+c・GUILD ROYALE などの企画募集 = a+b+c+d)の id・題・段階・BOUNTY のフォームの URL を匿名で読む(下書き・申請者・回答なし)。ASSEMBLE が id を書き込まずに入口から BOUNTY のフォームへ送るためGET取得
/api/v1/boshu/events/{slug}/forms認証なし・レート制限 - 公開中のイベント募集(パートナー募集、またはイベントの企画募集とそのパートナー質問c)の質問・イベント・規約版を匿名で読む(申請者・所属・連絡先なし)GET取得
/api/v1/boshu/{id}/partner/context認証なし - 認証済み本人の在籍中団体だけを選べる候補として返す(企画募集では対象種別と応募方針に合う団体だけ・登録済み/応募済みの印付き)。検索語があれば承認済み公開団体の名前を選べない参考として返す(運営権限による他団体検索なし)GET取得
/api/v1/boshu/{id}/partner/organizationsログイン - 本人の明示同意・必要な団体登録・既存BOSHU応募・イベントとの関連を一括保存する。イベントの企画募集では、同じイベントのパートナー登録(団体ごとに1回、登録済みなら再利用)と企画への応募を1回の送信で記録する(承認・所属確定・選考なし)POST作成・操作
/api/v1/boshu/{id}/partnerログイン・レート制限