Skip to content

Latest commit

 

History

History
1089 lines (592 loc) · 188 KB

AccountIntegrate.md

File metadata and controls

1089 lines (592 loc) · 188 KB

Account 帳號整合驗證平台

簡介

目的

  • 整合萬通內部資訊系統,進行整合驗證登入,以達到只需一組帳號,即可登入各資訊系統。
  • 提供資訊部管理各資訊系統使用者資訊與狀態,方便人員到職或離職帳號管控。
  • 透過同步HRM2系統使用者狀態,可以快速進行人員計行各資訊系統帳號管理。

專案升級評估

升級版本 React 19 + Next.js 15.1

  • 原版本React 18 + Next.js 14.2.3

流程說明

新增帳號

  1. 從Employee 資料表抓取HRM2 的使用者清單。
  2. 選擇使用者後,選擇要開通的系統別(例: 挑工、CRM),進行新增帳號(新增帳號預設狀態為: 1 => 啟用中)。
  3. 此時會呼叫對應系統的API(新增使用者API),進行新增使用者資料到該系統 (該系統預設使用者權限: 未啟用)。
  4. 完成新增帳號作業,帳號資料表(account)新增使用者資料、系統別資料表(system_list)新增系統。密碼預設: <同帳號>。

註1: 未選取開通的系統別也可以進行新增帳號。

修改帳號資料

  1. 帳號資料來源與狀態為HRM2,並且會透過同步資料的方式進行更新,所以不需要另外修改使用者資料。

登入系統

  1. 當新增帳號與開啟系統別之後,資訊人員需到該系統進行設定權限與啟用(系統預設使用者權限: 未啟用)。
  2. 設定完權限與啟用後,就可以進行登入作業。
  3. 使用者於開通的系統輸入帳號密碼進行登入,登入驗證階段會呼叫帳號整合平台的API進行認證。
  4. 帳號整合平台會比對帳號資料表(account) 的使用者與系統別資料表(system_list)進行驗證。
  5. 驗證成功後,產生該系統所屬的Token,並包含驗證成功訊息回傳給登入的系統別。
  6. 取得驗證成功與Token後,就可以使用該Token與後端通訊。

註: Token 到期時間預設為 24hr

帳號鎖定與關閉

  1. 員工帳號狀態可進行停用,當進行停用後,此員工所有的資訊系統都無法進行登入(status: 0:未啟用; 1:啟用; 2:停用)。
  2. 帳號關閉則依照HRM2上面使用者工作狀態(job_status)決定。 在職中: 1 => 帳號啟用中,可登入。 已離職: 2 => 帳號停用,不可登入。 留職停薪: 3 => 帳號停用,不可登入。
  3. 是否可登入各系統別狀態,則可透過<員工帳號管理>的登入系統別進行設定,目前先[不會針對個別系統別]進行啟用或鎖定作業。 (此執行作業會呼叫該系統API進行鎖定與啟用設定)

帳號狀態與查詢

  1. 帳號狀態(在職狀態)會在每天多個時段進行與HRM2同步作業(資料主要為個人基本資料與在職狀態)。 例: 該人員當日HRM2早上設定離職,則中午系統進行資料同步後,會變更為: 2 => 已離職。
  2. 查詢帳號資料時,則會抓取帳號管理的基本資料進行檢視。如要修改人員個人資料,則需要登入HRM2進行修改。

平台功能

平台說明

目前平台會分多階段進行開發,資訊系統管理功能。後續,會在2025年過年後,依照系統導入進度加入帳號權限與角色管理。

功能模組說明

  1. 帳號管理功能 => /account 已新增的帳號目前預設不可刪除,可進行帳號停用(status: 2) 帳號管理角色有: admin 系統管理員 (目前預設權限與owner相同) owner 資訊系統負責人 user 一般使用者
  2. 資訊系統管理 => /info-system
  3. 管理者設定 => /admin
  4. 登入 => /login
  5. 儀錶板 => /dashboard

後端 API 說明

API 說明

[系統別管理功能] SystemGroup

  1. 查詢服務系統別清單API (挑工、考勤打卡與CRM) => /getSystemList
  2. 建立新的服務系統別API => /createSystem
  3. 修改(移除)服務系統別API => /updateSystem

[使用者帳號資料表] AccountGroup

  1. 查詢使用者帳號使用者清單 => /getAccountList
  2. 新增使用者帳號資訊 => /createAccount
  3. 修改使用者帳號資訊 => /updateAccount

API

#API

登入

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 後站登入
POST/GET POST
URL URL+"/login"
Token No
params

\[Request body\]\[JsonObject\]
參數名 型態 說明 限制 參數意義
\*account string 帳號 字串長度1~20
\*password string 密碼 字串長度1~64
Return "data"(jsonObj):{

"account": "string,使用者帳號(工號),對照HRM的user_id",

"name": "string,姓名",

"department": "string,部門",

"role": "int,系統角色[1:系統管理員(admin) 2: 資訊人員(owner), 3: 一般使用者(user)]",

"token"(jsonObj): {

"access_token": "string, token",

"expires_in": "int,token存活時間(小時)[預設24小時]",

"expires_time":"datetime, token過期時間"

}

}

Sample
ErrorCode

(code:1)

1.帳號或密碼錯誤!

2.帳號已被停用。

架站建立

查詢服務系統別清單API (挑工、考勤打卡與CRM)

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 查詢服務系統別清單API (挑工、考勤打卡與CRM)
POST/GET POST
URL URL+"/system/getSystemList"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
Return "data"jsonArray: \[

{

"id": "int,ID",

"pid": int,專案編號",

"name": "string,系統名稱",

"systemCode": "string,專案代號或系統代號",

"systemType": "int,系統類型(1:套裝系統; 2:自開發系統)",

"systemTypeName": "string,系統類型(1:套裝系統; 2:自開發系統)",

"port": "string,port號",

"apiUrl": "string,系統API服務網址",

"status": "int,系統狀態(0:未啟用; 1:啟用中; 2:已停用)",

"statusTxt": "string,系統狀態(0:未啟用; 1:啟用中; 2:已停用)",

"description": "string,說明",

"createdBy": "string,建立者帳號",

"createdByName": "string,建立者",

"modifiedBy": "string,修改者帳號",

"modifiedByName": "string,修改者",

"modifiedTime": "string,修改時間",

"createdTime": "string,建立時間",

},...

]

Sample >

ErrorCode

(code:1)

建立日期 架站建立

建立新的服務系統別API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 建立新的服務系統別API
POST/GET POST
URL URL+"/system/createSystem"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*pidint專案編號
\*systemCodestring專案代號或系統代號
\*namestring系統名稱
\*systemTypeint系統類型 (1:套裝系統; 2:自開發系統)
portstring
\*apiUrlstring系統API服務網址
\*statusint系統狀態 (0:未啟用; 1:啟用中; 2:已停用)
descriptionstring說明
Return "data":{

"name": "string,系統名稱",

}

Sample > ** 範例: **

ErrorCode

(code:1)

建立日期 架站建立

修改服務系統別API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 修改服務系統別API
POST/GET POST
URL URL+"/system/updateSystem"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*namestring系統名稱
\*systemTypeint系統類型 (1:套裝系統; 2:自開發系統)
portstring
\*apiUrlstring系統API服務網址
\*statusint系統狀態 (0:未啟用; 1:啟用中; 2:已停用)
descriptionstring說明
\*idint
Return "data": {

"name": "string,系統名稱",

}

Sample > ** 範例: **

ErrorCode

(code:1)

建立日期 架站建立

查詢使用者帳號使用者清單API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 查詢使用者帳號使用者清單API
POST/GET POST
URL URL+"/account/getAccountList"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
Return "data"jsonArray: \[

{

"id": "int,ID",

"account": string,帳號",

"name": "string,姓名",

"email": "string,信箱",

"role": "int,系統角色 0:系統管理員(admin)1:代理管理員 2: 資訊人員(owner), 3: 一般使用者(user)",

"roleName": "string,系統角色",

"jobStatus": "int,在職狀態(1:在職2:離職3:留職停薪)",

"jobStatusName": "string,在職狀態(1:在職2:離職3:留職停薪)",

"status": "int,帳號狀態(0:未啟用; 1:啟用中; 2:已停用)",

"companyId": "string,公司編號",

"companyName": "string,公司",

"departmentName": "string,部門名稱",

"departmentShortName": "string,部門簡稱",

"createdTime": "string,建立時間",

"modifiedTime": "string,修改時間",

"modifiedBy": "string,修改者帳號",

"modifiedByName": "string,修改者",

"useSystem": "string,資訊系統權限",

"roleInfo"jsonArray: [

{

"id": "int,ID",

"systemCode":"string,專案代號或系統代號",

"name":"string,系統名稱",

"roleSet":"int,(1:有權限;0:沒有權限)",

"isLock":"int,是否鎖定(0:未鎖定; 1:鎖定)",

"lastLoginTime": "string,最後登入時間",

"modifiedTime": "string,修改時間",

"modifiedBy": "string,修改者帳號",

"modifiedByName": "string,修改者",

},...

]

},...

]

Sample > ** 範例: **

ErrorCode

(code:1)

建立日期 架站建立

取得HRM員工基本資料API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 取得HRM員工基本資料API
POST/GET POST
URL URL+"/employee/getEmployeeInfo"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*userIdint員工HRM2帳號
Return "data"jsonArray: \[

{

"id": "int,ID",

"userId": int,員工HRM2帳號",

"employeeName": "string,員工姓名",

"jobStatus": "int,在職狀態 (1:在職2:離職3:留職停薪)",

"jobStatusName": "string,在職狀態 (1:在職2:離職3:留職停薪)",

"companyId": "int,HRM公司編號",

"companyName": "string,公司",

"departmentName": "string,部門",

"departmentShortName": "string,部門簡稱",

"email": "string,信箱",

"updatedTime": "string,修改時間",

}

]

Sample > ** 範例: **

ErrorCode

(code:1)

1.員工不存在於HRM中,請確認。
建立日期 架站建立

新增使用者帳號資訊API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 新增使用者帳號資訊API
POST/GET POST
URL URL+"/account/createAccount"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*accountstring使用者帳號
\*namestring姓名
\*companyIdstring公司編號
\*departmentNamestring部門
\*emailstring信箱
\*roleint系統角色 系統角色。0:系統管理員(admin)1:代理管理員 2: 資訊人員(owner), 3: 一般使用者(user)
systemCodestring資訊系統代碼 格式 :

"MSCRM,PICKING"

\*sourceint帳號來源 帳號來源: 0:系統; 1:HRM2(預設); 2:自定義
Return "data":{

"account": "string,帳號",

"name": "string,姓名"

}

Sample > ** 範例: **

ErrorCode

(code:1)

1.此帳號已存在。
建立日期 架站建立

[X]查詢User使用者帳號資訊API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 查詢User使用者帳號資訊API
POST/GET POST
URL URL+"/account/getAccountInfo"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*accountstring員工HRM2帳號
Return "data":{

"accountInfo"jsonArray: [

{

"id": "int,ID",

"account": int,員工HRM2帳號",

"name": "string,員工姓名",

"jobStatus": "int,在職狀態 (1:在職2:離職3:留職停薪)",

"jobStatusName": "string,在職狀態 (1:在職2:離職3:留職停薪)",

"status": "int,帳號狀態(0:未啟用; 1:啟用中; 2:已停用)",

"companyId": "int,HRM公司編號",

"companyName": "string,公司",

"departmentName": "string,部門",

"departmentShortName": "string,部門簡稱",

"email": "string,信箱",

"role": "string,角色",

"createdTime": "string,建立時間",

"modifiedTime": "string,修改時間",

}

],

"role"jsonArray: [

{

"id": "int,ID",

"systemCode": string,專案代號或系統代號",

"name": "string,系統名稱",

"roleSet": "int,系統權限 (1:有0:無)",

"isLock": "int,啟用狀態 (1:啟用0:不啟用)",

"modifiedTime": "string,修改時間",

},...

]

}

Sample > ** 範例: **

ErrorCode

(code:1)

建立日期 架站建立

修改使用者帳號資訊API

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 修改使用者帳號資訊API
POST/GET POST
URL URL+"/account/updateAccount"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*jsonStringstringJson String 字串格式:

'{"account":"admin",
"name":"系統管理員",
"role":1,
"status":0,
"roleInfo":[
{
"systemCode":"MSCRM",
"updateFlag":1
},
{
"systemCode":"ATTEND",
"updateFlag":3
}
]
}'

參數說明:

account - string 帳號,

name - string 姓名,

role - int 系統角色[0:系統管理員(admin)1:代理管理員 2: 資訊人員(owner), 3: 一般使用者(user)], status - int 帳號狀態[0:未啟用; 1:啟用中; 2:已停用]

--

systemCode - string 專案代號或系統代號,

updateFlag - int 0:不做任何處理;

1:[insert,未啟用(鎖定)];

2:[insert,啟用(未鎖定)];

3:[update,未啟用(鎖定)];

4:[update,啟用(未鎖定)]

Return "data": {

"account": "string,帳號",

"name": "string,姓名",

}

Sample > ** 範例: **

ErrorCode

(code:1)

建立日期 架站建立

密碼重置

URL:API ServerUrl+"/admin"

認證:後站Token (經Login取得)

API名稱 #### 密碼重置API
POST/GET POST
URL URL+"/account/resetPassword"
Token Yes
params

\[FromForm\]
參數名 型態 說明 限制 參數意義
\*accountstring使用者帳號
Return "data":{

"table_name": "string,紀錄資料表名稱(attend_log)",

"rowcount": "int,更新資料筆數",

"processing_time": "string,處理時間",

"err_msg": "string,錯誤訊息",

}

Sample > ** 範例: **

ErrorCode

(code:1)

1.使用者帳號不存在。

2.使用者帳號已被停用,請聯絡系統管理員。

建立日期 架站建立