Cracker API概要
Crackerではデータベースとフロントエンドとの接続にREST APIを用いています。
REST APIを使用することでデータベースの各種操作が行なえます。
APIの共通仕様
プロトコル
HTTPS
メディアタイプ
application/json
文字コード
UTF-8
認証
APIトークン認証を行います。
HTTPヘッダーの「Auth-Api-Key」に生成されたAPIトークンを設定してください。
リクエストヘッダー
REST APIをリクエストする場合、以下のリクエストヘッダーが共通で必要です。
| ヘッダー名 | 説明 |
|---|---|
| Auth-Api-Key | APIキー |
エラーレスポンス
APIの使用で正常に動作が行われない場合、以下のエラー応答情報を返却します。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 文字列 | エラーコード |
| message | 文字列 | エラーメッセージ |
例)
{
"code" : "500" ,
"messages" : [ "エラーメッセージ" ]
}
扱うデータ形式
REST APIを使用する際の各種パラメータやリクエストボディで指定するデータ及びレスポンスされるデータの形式は全て「データベース構成と規則」に準拠しています。
リソース一覧
提供するREST APIの一覧
| API名 | メソッド | エンドポイント | 説明 |
|---|---|---|---|
| ユーザー取得 | GET | /users | ユーザー情報を取得します |
| ユーザー登録 | POST | /users | 新規ユーザーを登録します |
| ユーザー更新 | PUT | /users | 既存ユーザー情報を更新します |
| ユーザー削除 | DELETE | /users | 既存ユーザーを削除します |
| ゲスト取得 | GET | /guests | ゲスト情報を取得します |
| ゲスト登録 | POST | /guests | 新規ゲストを登録します |
| ゲスト更新 | PUT | /guests | 既存ゲスト情報を更新します |
| ゲスト削除 | DELETE | /guests | 既存ゲストを削除します |
| ゲスト検索 | GET | /guests/search | ゲスト情報を検索します |
| 展示取得 | GET | /exhibits | 展示情報を取得します |
| 展示登録 | POST | /exhibits | 新規展示を登録します |
| 展示更新 | PUT | /exhibits | 既存展示情報を更新します |
| 展示削除 | DELETE | /exhibits | 既存展示を削除します |
| アクティビティ取得 | GET | /activities | アクティビティ情報を取得します |
| アクティビティ登録 | POST | /activities | 新規アクティビティを登録します |
| 招待コード取得 | GET | /invitations | 招待コード情報を取得します |
| 招待コード登録 | POST | /invitations | 新規招待コードを登録します |
| 招待コード削除 | DELETE | /invitations | 既存招待コードを削除します |
| ロール取得 | GET | /roles | ロール情報を取得します |
| ロール登録 | POST | /roles | 新規ロールを登録します |
| ロール更新 | PUT | /roles | 既存ロール情報を更新します |
| ロール削除 | DELETE | /roles | 既存ロール情報を削除します |
| ユーザー所持ロール取得 | GET | /usersroles | ユーザーの所持しているロールを取得します |
| ユーザー所持ロール登録 | POST | /usersroles | ユーザーに新たなロールを登録します |
| ユーザー所持ロール削除 | DELETE | /usersroles | ユーザーの所持しているロールを削除します |
| QRコード生成 | GET | /qr | Cracker用QRコードを生成します |