企画公開 API
これは何か
大学祭に参加するサークルの企画情報を外部システムに公開する API です。
「今年の大学祭にどんな企画があるか」を知りたい外部システム(パンフレットアプリ・Web サイト・会場案内システムなど)が、この API を呼び出してサークル一覧や詳細を取得します。
誰が使うか
- 外部システム:認証なしでアクセスして企画情報を取得する
- 人間は直接使わない:この API は外部システムが機械的に呼び出すためのもの
提供する情報のイメージ
- 「今年の大学祭(イベントプレフィックス指定)に参加しているサークルの一覧」
- 「特定のサークル企画の詳細(企画名・場所・カテゴリ・タグなど)」
できなければならないこと
- 外部システムが認証なしで、イベントプレフィックスを指定してそのイベントの承認済み企画一覧を取得できる
- 外部システムが認証なしで、企画IDを指定して特定の企画の詳細を取得できる
できてはいけないこと
- まだ審査中・審査に通っていないサークルの情報を返すこと。外部に公開されるのは運営が承認した企画だけ。
- アーカイブされた(過去のものとして整理された)企画の情報を返すこと。
- 個人情報や内部メモなど、公開を想定していない情報を返すこと。
- この API でデータを書き込むこと。読み取り専用。
- イベントプレフィックスを指定せずに、過去のすべてのイベントの企画を横断して取得できること。イベント単位での参照に限定する。