Phoebus API
Giới thiệu
Phoebus API là những API do Phoebus cung cấp dựa trên chuẩn REST (Representational State Transfer). Phoebus API cung cấp khả năng truy xuất và quản lý dữ liệu dễ dàng thông qua các giao thức http/https (như GET, POST, PUT, DELETE...)
Nhờ khả năng linh hoạt của chuẩn REST mà Phoebus API có thể hoạt động ở nhiều nơi như: web, mobile hay các phần mềm được cấp phép sử dụng khác.
Phoebus API trả về dữ liệu theo định dạng Json.
Lưu ý:
- Để sử dụng Phoebus API người dùng có thể dùng các phần mềm như Postman, Fiddler… Hướng dẫn này sử dụng Postman để làm việc với Phoebus API.
- Người dùng cần có hiểu biết cơ bản về Phoebus Command trước khi đọc hướng dẫn này.
Cách thức hoạt động của Phoebus API
Cách thức hoạt động của Phoebus API được mô tả như hình bên dưới:
Để sử dụng Phoebus API người dùng cần thực hiện 2 bước:
Bước 1: đăng nhập vào hệ thống:
Người dùng đăng nhập vào hệ thống với tên và mật khẩu được cung cấp.
Nếu đăng nhập thành công, Server sẽ trả về thông tin tài khoản kèm Token
Nếu đăng nhập thất bại, người dùng cần kiểm tra lại tên đăng nhập/mật khẩu hoặc liên hệ với system admin.
Bước 2: thực hiện truy vấn dữ liệu thông qua Phoebus API.
Sử dụng token lấy khi đăng nhập và gửi các request tới API Service.
Cấu trúc chung của Phoebus API
Phoebus API bao gồm 3 phần chính:
ServiceEndPoint/Function/ID hoặc filters
ServiceEndPoint/Function trả về danh sách dữ liệu infolist của Function.
ServiceEndPoint/Function/id trả về mẫu tin trong Function với mã id.
ServiceEndPoint/Function?filters trả về danh sách dữ liệu của Function với điều kiện filters.
ServiceEndPoint là địa chỉ của máy chủ hoặc dịch vụ mà API sẽ kết nối tới.
Một số EndPoint mà Phoebus API sử dụng bao gồm:
- 118.69.187.103:8080/PhoebusAPI/
- http://phoebusmobileapi.azurewebsites.net/PhoebusAPI/
Function là chức năng của Phoebus mà người dùng cần sử dụng. Function của Phoebus API tương tự như Phoebus Command.
ID hoặc filters:
- ID: là mã của record muốn lấy
- Filters: là các điều kiện lọc dữ liệu, tương tự như Phoebus Command, các điều kiện lọc cách nhau bởi dấu “&”.
Ví dụ sau đây sẽ giúp mô tả một cách tổng quát về sự tương quan giữa Phoebus Command và API
| Mục đích | Phoebus Command | API |
|---|---|---|
| Lấy danh sách nhân viên | pbs.BO.HR.EMP | 118.69.187.103:8080/PhoebusAPI/pbs_bo_hr_emp |
| Lấy nhân viên có mã là E0001 | pbs.BO.HR.EMP?EmplCode=E0001 | 118.69.187.103:8080/PhoebusAPI/pbs_bo_hr_emp/E0001 |
| Lấy tất cả nhân viên có giới tính nam và mang quốc tịch Việt Nam | pbs.BO.HR.EMP?Gender=M&Nationality=VN | 118.69.187.103:8080/PhoebusAPI/pbs_bo_hr_emp?gender=m&nationality=vn |
Xem thêm
Updated on : 2023-01-07 13:59:07. by : . at X1-EXTREME.
Topic : api