アカウント登録＿API

概要

{success} KIZUNAを運営する本システムにログインできるアカウントを登録するAPIです。

エンドポイント

メソッド URI Headers
POST /api/account Default

リクエストパラメーター

パラメーター名 型 内容 特記
id int ＩＤ ※新規登録の場合はnullが渡されます。
name string アカウント名称
login_id string アカウントログインＩＤ
password string パスワード ※編集の場合は任意項目になります。 
{
    'id'                        : 1,
    'name'                      : 'テスト管理者',
    'login_id'                  : 'admin@gmail.com',
    'password'                  : 'password123456',
}

レスポンス

成功時
パラメーター名 型 内容 特記
id int id アカウント新規作成時も更新時もIDを返却します。 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id': 1,
  },
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List エラーメッセージ 
{
  "result"   : false,
  "errors"                      : {
    'name'                      : '25文字以内で入力してください。',
    'login_id'                  : '255文字以内で入力してください。',
    'password'                  : '英数小文字8桁以上で設定してください',
  },
  "data"     : "",
}

バリデーション

画面項目名 フィールド名 チェック内容 備考
ログインID login_id required


email


max:255


ログインID重複チェック ・下記3項目ででuniqueになるようチェックを行います。
cmps_accounts.login_id
cmps_accounts.deleted_at
名前 name required


max:100
パスワード password required　（※） ※編集時にパスワードを変更しない場合は
nullが渡されるのでnullableになります。


指定文字種のみ許可 ・下記3項目を許可
半角英数字
半角ハイフン
半角アンダーバー
・クラス：App\Rules\CharacterType\Identifier


between:8,20

データストア

cmps_accounts

物理名 フィールド名 型 備考
name name string
login_id login_id string
password password string 編集時、パスワードを変更しない場合は
saveする際に渡すパラメータから除外してください。
created_at － datetime 新規登録時、現在日時を登録します。
updated_at － datetime 編集時、現在日時を登録します。

RUN