ログイン

---

• ログイン
  • 概要
  • エンドポイント
  • リクエストパラメーター
  • レスポンス
  • バリデーション
  • RUN

概要

ログイン者はKIZUNA管理者のみとなる。

アカウント発行は、管理者が発行したアカウントのみとする。（管理画面内で発行）

---

エンドポイント

メソッド	URI	Headers
POST	/api/login	Default(api_tokenなし)

---

リクエストパラメーター

パラメーター名	型	内容	特記
login_id	string	ログイン ID メールアドレス
password	string	パスワード 英数小文字８桁以上

{
  'login_id': 'admin@gmail.com',
  'password': 'password',
};

---

レスポンス

成功時

パラメーター名	型	内容	特記
id	int	アカウントID
name	string	アカウント名称
api_token	string	アカウントのAPI_TOKEN

{
  "result"   : true,
  "errors"   : "",
  "data" :{
    'id': 1,
    'name': 'SAI myott SETT',
    'api_token': '7fc935e178cc36994f92f5b097b8c97ea114824144c00a313ce258981539c199',
  }
}

{danger} Laravel + vuerouter + vuex + jetstreamの場合の実装方法調査後にレスポンスのパラメータ項目変更の可能性あり

失敗時

ステータスコード：200

パラメーター名	型	内容	特記
result	boolean	リクエスト結果
error	string	連想配列 / パラメータとkeyを同一にするように

{
  "result"   : false,
  "errors"   : {
    'login_id' : '必須項目です。||メールアドレスの形式で入力してください。',
    'password' : '必須項目です。||不正な文字が使われています。',
    'dismatch' : 'メールアドレスか、パスワードが間違っています。',
  },
  "data"     : "",
}

---

バリデーション

画面項目名	フィールド名	チェック内容	備考
メールアドレス	login_id	required
		email
		max:255
パスワード	password	required
		指定文字種のみ許可	・下記3項目を許可 半角英数字 半角ハイフン 半角アンダーバー ・クラス：App\Rules\CharacterType\Identifier
		between:8,20

バリデーションを記述するクラス

App\Http\Requests\Api\Login\LoginRequest

---

RUN