Cùng với các thao tác trực tiếp trên phần mềm Paradise HRM, người dùng còn có thể thông qua Paradise API thực hiện các hành động như nhập mới, cập nhật, xóa, lấy dữ liệu. Vì vậy trong bài viết này, Công ty phần mềm Việt Tín sẽ trình bày cụ thể về cấu trúc chung cũng như cách kết nối với Paradise API, để các bạn có thể nắm được, hiểu được và thao tác được.
Cấu trúc chung
1. Cấu trúc của Paradise API
Để gọi được Paradise API của Phần mềm Paradise HRM, bạn cần xác định được 2 phần đó là URL và Authentication (thông tin đăng nhập cho Paradise API).
| URL | – Là địa chỉ máy chủ của công ty bạn nơi có cài đặt services Paradise HRS. Kèm theo port của phần mềm ví dụ: 8081 hoặc 6900 hoặc bất kỳ port nào lúc cài đặt phần mềm bạn cấu hình để đặt cho phần Paradise HRS trên máy chủ của công ty bạn. Thường hay sử dụng port 8081 hoặc 6900. – Cấu hình đầy đủ của url là http://[IP address]:Port/api/hpa/Paradise. – Trong đó: api/hpa/Paradise là Controller của Paradise API bắt buộc phải có. |
| Authentication | – Thông tin xác thực bao gồm User và Password để đăng nhập vào Paradise API. – Thường hay sử dụng User là: adm và Password mặc định là: 123 – Password của User adm bạn có thể đổi trong phần mềm Paradise HR được cài đặt ở máy của nhân viên nhân sự. – Như vậy cấu trúc cần để gọi Paradise API là: http://[IP address]:Port/api/hpa/Paradise?user=adm&pass=123 => Đây là điều cần nhưng chưa đủ bạn cần cung cấp tên hàm api và tham số truyền vào để có thể lấy dữ liệu hoặc cập nhật dữ liệu. |
2. Cách gọi Paradise API
2.1 Cấu trúc đầy đủ của một Paradise API
http://[IP address]:[Port]/api/hpa/Paradise?Authentication& API_Name&Params
2.2 Ví dụ
Hàm Paradise API dưới đây trả về danh sách các máy chấm công:
=> http://192.168.2.28:8081/api/hpa/Paradise?user=adm&pass=123&name=API_DeviceList¶m=[]
Cấu trúc của API lấy danh sách các máy chấm công
Một số Paradise API thông dụng
1. Nhập hồ sơ nhân viên mới
1.1 Cấu trúc
/api/hpa/Paradise?user=adm&pass=123&name=sp_ImportEmployeeInfor¶m=[]
1.2 Ví dụ
Trường hợp các bạn muốn nhập hồ sơ nhân viên mới với các thông tin sau:
| Mã nhân viên (EmployeeID) | 80073 |
| Tên đầy đủ (FullName) | Nguyễn Thái Minh |
| Bộ phận (DepartmentName) | Công nghệ thông tin |
| Chức vụ (PositionName) | Nhân viên IT |
| Giới tính (Sex) | Nam |
| Ngày sinh (Birthday) | 1992-02-17 (lưu ý định dạng ngày luôn là: yyyy-MM-dd. 1992-2-17 sẽ không hợp lệ) |
| Ngày vào làm (HireDate) | 2020-11-23 |
| Mã chấm công (Acc_ID) | 80073 |
| Loại nhân viên (EmployeeTypeName) | Nghỉ CN – 48h |
| Loại nhân viên |
| Nghỉ CN – 48h |
| Nghỉ T7 và CN – 40h |
| Làm xoay ca |
| Đi làm T7 nghỉ CN |
Từ các phần trên, ta có được các thành phần cấu thành Paradise API nhập hồ sơ nhân viên mới như sau:
| Tên thành phần | Mô tả cụ thể |
| Controller | /api/hpa/Paradise |
| Authentication | user=adm&pass=123 |
| Tên hàm API | name=sp_ImportEmployeeInfor |
| Tham số truyền vào (theo dạng: [“tên tham số”,”giá trị”,…,”tên tham số”,”giá trị”]) | [“EmployeeID”, “80073”,”FullName”, “Nguyễn Thái Minh”,”DepartmentName”, “Công nghệ thông tin”,”PositionName”, “Nhân viên IT”,”Sex”, “male”,”Birthday”, “1992-02-17″,”HireDate”, “2020-11-23″,”Acc_ID”, “80073”,”EmployeeTypeName”,”Nghỉ CN – 48h”] |
Ngoại trừ giữa 2 phần Controller và Authentication ngăn cách bởi ký tự “?“, các phần còn lại sẽ ngăn cách bằng ký tự “&“. Như vậy ta có được Paradise API nhập hồ sơ nhân viên mới hoàn chỉnh:
=> /api/hpa/Paradise?user=adm&pass=123&name=sp_ImportEmployeeInfor¶m=[“EmployeeID”, “80073”,”FullName”, “Nguyễn Thái Minh”,”DepartmentName”, “Công nghệ thông tin”,”PositionName”, “Nhân viên IT”,”Sex”, “male”,”Birthday”, “1992-02-17″,”HireDate”, “2020-11-23″,”Acc_ID”, “80073”,”EmployeeTypeName”,”Nghỉ CN – 48h”]
Kết quá trả về:
2. Cập nhật thông tin nhân viên
2.1 Cấu trúc
Vẫn dùng cấu trúc API tương tự khi nhập hồ sơ nhân viên mới : /api/hpa/Paradise?user=adm&pass=123&name=sp_ImportEmployeeInfor¶m=[]
2.2 Ví dụ
Khi muốn cập nhật nhân viên 80073 đổi tên từ Nguyễn Thái Minh thành Nguyễn Thanh Minh, ta thực hiện gọi Paradise API tương tự như khi nhập hồ sơ nhân viên mới, chỉ khác cặp “Tên tham số” – “Giá trị” từ “FullName” – “Nguyễn Thái Minh” sẽ đổi thành “FullName” – “Nguyễn Thanh Minh”, ta tiến hành gọi Paradise API như sau:
=> /api/hpa/Paradise?user=adm&pass=123&name=sp_ImportEmployeeInfor¶m=[“EmployeeID”, “80073”,”FullName“,”Nguyễn Thanh Minh“,”DepartmentName”, “Công nghệ thông tin”,”PositionName”, “Nhân viên IT”,”Sex”, “male”,”Birthday”, “1992-02-17″,”HireDate”, “2020-11-23″,”Acc_ID”, “80073”,”EmployeeTypeName”,”Nghỉ CN – 48h”]
Kết quả:
3. Xóa hồ sơ nhân viên
3.1 Cấu trúc
/api/hpa/Paradise?user=adm&pass=123&name=API_DeleteEmployeeProfile¶m=[]
3.2 Ví dụ
Để xóa hồ sơ nhân viên có mã 80073, ta cần các thành phần:
| Tên thành phần | Mô tả cụ thể |
| Controller | /api/hpa/Paradise |
| Authentication | user=adm&pass=123 |
| Tên hàm API | name=API_DeleteEmployeeProfile |
| Tham số truyền vào (theo dạng: [“tên tham số”,”giá trị”,…,”tên tham số”,”giá trị”]) | param=[“EmployeeID”, “80073”] |
Tiến hành gọi Paradise API như sau:
=> /api/hpa/Paradise?user=adm&pass=123&name=API_DeleteEmployeeProfile¶m=[“EmployeeID”, “80073”]
Kết quả:
4. Cập nhật trạng thái nhân viên
| Mã trạng thái | Tên trạng thái | Tên trạng thái (English) |
| 0 | Làm việc bình thường | Working |
| 1 | Đang nghỉ thai sản | Maternity |
| 2 | Nghỉ lưu chức | Unpaid leave long term |
| 3 | Nghỉ ốm nhiều ngày | Sick leave long term |
| 4 | Sắp nghỉ | Submitted termination letter |
| 10 | Hưởng chế độ mang thai | Before maternity |
| 11 | Hưởng chế độ con nhỏ | After maternity |
| 20 | Đã nghỉ việc | Terminated |
4.1 Cấu trúc
/api/hpa/Paradise?user=adm&pass=123&name=API_UpdateEmployeeStatus¶m=[]
4.2 Ví dụ
Khi muốn cập nhật trạng thái nhân viên từ “Làm việc bình thường” – Mã trạng thái = 0 thành “Đã nghỉ việc” – Mã trạng thái = 20, ta có các thành phần Paradise API:
| Tên thành phần | Mô tả cụ thể |
| Controller | /api/hpa/Paradise |
| Authentication | user=adm&pass=123 |
| Tên hàm API | name=API_UpdateEmployeeStatus |
| Tham số truyền vào (theo dạng: [“tên tham số”,”giá trị”,…,”tên tham số”,”giá trị”]) | param=[“EmployeeStatusID”,”20″,”EmployeeID”, “80073”,”EffectiveDate”, “2021-01-01”] |
Ta tiến hành gọi Paradise API như sau:
=> /api/hpa/Paradise?user=adm&pass=123&name=API_UpdateEmployeeStatus¶m=[“EmployeeStatusID”,”20″,”EmployeeID”, “80073”,”EffectiveDate”, “2021-01-01”]
Kết quả:
5. Lấy dữ liệu chấm công thô của nhân viên từ máy chấm công
Ngoài các Paradise API để tương tác với thông tin nhân viên kể trên, còn có các Paradise API liên quan đến phần dữ liệu chấm công trên máy chấm công. Như là lấy danh sách nhân viên, lấy chi tiết thông tin nhân viên, lấy dữ liệu chấm công thô, …. Ở đây sẽ ví dụ về Paradise API lấy dữ liệu chấm công thô từ máy chấm công.
5.1 Cấu trúc
/api/hpa/Paradise?user=adm&pass=123&name=API_AttendanceList¶m=[]
5.2 Ví dụ
Khi muốn lấy dữ liệu chấm công thô của nhân viên 000002, Đào Văn Long, từ ngày 1 tháng 9 năm 2021 đến ngày 7 tháng 9 năm 2021, ta có các thành phần sau:
| Tên thành phần | Mô tả cụ thể |
| Controller | /api/hpa/Paradise |
| Authentication | user=adm&pass=123 |
| Tên hàm API | name=API_AttendanceList |
| Tham số truyền vào (theo dạng: [“tên tham số”,”giá trị”,…,”tên tham số”,”giá trị”]) | param=[“FromDate”,”2021-09-01″,”ToDate”,”2021-09-07″,”EmployeeID”,”000002″] |
Tiến hành gọi Paradise API như sau:
=> /api/hpa/Paradise?user=adm&pass=123&name=API_AttendanceList¶m=[“FromDate”,”2021-09-01″,”ToDate”,”2021-09-07″,”EmployeeID”,”000002″]
Kết quả:
6. Danh sách nhân viên theo máy chấm công
Gọi hàm API_EmployeeListByDevices để liệt kê danh sách nhân viên theo máy chấm công
6.1 Cấu trúc
/api/hpa/Paradise?user=adm&pass=123&name= API_EmployeeListByDevices ¶m=[]
6.2 Ví dụ
Ví dụ muốn lấy danh sách nhân viên đang có trên máy chấm công ở xưởng 2 thì gọi hàm như sau:
/api/hpa/Paradise?user=adm&pass=123&name=API_EmployeeListByDevices¶m=[“SerialNumber”,”6171204200001″]
6.3 Kết quả
Kết quả trả về:
7. Chi tiết thông tin nhân viên trên máy chấm công, có hình
Gọi hàm API_EmployeeListByDevices để liệt kê danh sách nhân viên theo máy chấm côn
/api/hpa/Paradise?user=adm&pass=123&name=API_GetEmployeeDetailListByDevices¶m=[]
Ví dụ muốn lấy thông tin nhân viên kèm hình ảnh đang có trên máy chấm công ở xưởng 2 thì gọi hàm như sau:
/api/hpa/Paradise?user=adm&pass=123&name=API_GetEmployeeDetailListByDevices¶m=[“SerialNumber”,”6171204200001″,”EmployeeID”,”00001″]
Kết quả trả về:
Lời kết
Trên đây đã trình bày cụ thể và trực quan về Paradise API, công cụ giúp người dùng có thể thao tác với dữ liệu nhân viên, dữ liệu chấm công. Từ các nội dung và ví dụ trên, các bạn có thể hoàn toàn tự thao tác theo ý mình để lấy, tạo mới, cập nhật dữ liệu mong muốn. Trong quá trình thao tác, nếu gặp khó khăn hay vướng mắc gì, các bạn có thể bình luận phía dưới bài viết, mình sẽ phản hồi hỗ trợ nhé. Thân ái.