Kiểm nghiệm API với Postman
Yêu cầu bắt buộc cần có tên miền MShopKeeper được kích hoạt và thiết lập cho phép kết nối với API đến các phần mềm khác. Xem thêm tại đây
Các cấu hình cần thiết:
| AppID | Domain | Secret Key |
|---|---|---|
| AppID | Tên kết nối | Mã bảo mật |
Thực hiện cài đặt công cụ kiểm nghiệm API Postman
Bài viết sử dụng Postman for Windows | Version 7.13.0
Tải Postman phiên bản mới nhất tại đây (https://www.getpostman.com/downloads/)
Tải file cấu hình MShopKeeperOpenPlatform.postman_collection.json tại đây
Sau khi tải xong thực hiện cài đặt chương trình, và mở chương trình lên.
Thực hiện import file MShopKeeperOpenPlatform.postman_collection.json và sửa lại các cấu hình theo tên miền của bạn theo hướng dẫn dưới đây.
- Giao diện chương trình
Bước 1: Thực hiện import file MShopKeeperOpenPlatform Collection
Chọn menu File > Import...
Tại popup hiện lên, tab Import File bấm Choose Files
Trỏ đường dẫn tới file MShopKeeperOpenPlatform.postman_collection.json đã tải ở trước đó để import
Thông báo import thành công trên Postman
Bước 2: Thực hiện sửa lại các cấu hình lấy được từ API Login để dùng cho các API khác
Bấm vào icon Show Sidebar góc dưới cùng bên trái, chọn tab Collections sẽ thấy collection MShopKeeperOpenPlatform,
Mở ra và chọn API api/account/login
Chú ý: nhớ chọn lại Enviroment(Môi trường) là ReleasePublic
Thực hiện nhập thông tin request lên API theo cấu hình từ tên miền của bạn, xem cách build thông tin đăng nhập tại đây, rồi bấm Send để lấy các thông tin cấu hình dùng gọi tới các API khác.
Sau khi nhận được kết quả trả về từ API, lưu lại các thông tin:
| Tên | Mô tả |
|---|---|
| CompanyCode | Mã cửa hàng lấy |
| AccessToken | Chuỗi token xác thực |
| Environment | Sub path để gọi request tới api lấy dữ liệu |
và cập nhật vào các variable (biến môi trường) trên Postman trong collection MShopKeeperOpenPlatform
Có thể xem các ví dụ request đã có trong menu Example
Mở trang cấu hình các biến môi trường CompanyCode, AccessToken, Environment trên Postman, bấm vào icon cài đặt (góc trên cùng bên phải).
Tại cửa sổ hiện lên, chọn dòng cấu hình ReleasePublic
Cập nhật lại các cấu hình lấy được từ API đăng nhập vào các biến tương ứng: 1, 2, 3, rồi bấm Update, để lưu lại thay đổi
Bước 3: Thực hiện kiểm nghiệm các api khác sau khi cấu hình thông tin đăng nhập
Sau khi hoàn tất bước 2, từ bây giờ có thể thực hiện gửi request tới các API khác trên hệ thống, với các tham số của tên miền tương ứng.
Ví dụ: Kiểm nghiệm API lấy danh sách nhóm hàng hóa
- Tham số
- Kết quả
