メインコンテンツまでスキップ

書類取得 API

これは何か

サークルが提出・承認された書類の内容を外部システムに提供する API です。

たとえば、衛生管理書類(食品を扱う模擬店が提出する書類)を会場管理システムが確認したい、という場面を想像してください。この API を使うと、外部システムが「サークルAの衛生管理書類は承認されているか?その内容は?」を Happa に問い合わせることができます。

誰が使うか

  • 外部システム:認証なしでアクセスして書類の内容を取得する

提供する情報のイメージ

  • 「サークルAが提出した書類Bの承認済み内容」
  • テキストで提出された場合はそのテキスト
  • ファイルで提出された場合は承認されたファイルの URL

できなければならないこと

  • 外部システムが認証なしで、サークルプロジェクトIDと書類種別IDを指定して承認済み書類のデータを取得できる
  • テキスト提出かファイル提出かを指定して適切な形式で受け取れる
  • イベントプレフィックスを指定して、そのイベント内の全サークルの特定書類をまとめて取得できる

できてはいけないこと

  • まだ承認されていない書類(審査中・却下・未提出)のデータを返すこと
  • 承認されていないサークルの書類を返すこと
  • 承認済みであっても古いバージョンのファイルを返すこと。常に最新の承認済みバージョンを返す。
  • この API でデータを書き込むこと。読み取り専用。