TÀI LIỆU HƯỚNG DẪN
KẾT NỐI, TÍCH HỢP, CHIA SẺ DỮ LIỆU
VỚI CỔNG DỊCH VỤ CÔNG QUỐC GIA
I. Các dịch vụ chia sẻ, tích hợp
Trục tích hợp cung cấp nhóm dịch vụ danh mục dùng chung như sau:
STT | Danh mục | API | Mô tả |
1 | Danh mục tỉnh, thành phố | LayDanhMucTinhThanh | Gói tin cung cấp phương thức lấy danh sách Tỉnh, Thành phố |
2 | Danh mục quận, huyện | LayDanhMucQuanHuyen | Gói tin cung cấp phương thức lấy danh sách Quận, huyện |
3 | Danh mục phường, xã | LayDanhMucPhuongXa | Gói tin cung cấp phương thức lấy danh sách Phường, xã |
4 | Danh mục cơ quan | LayDanhMucCoQuan | Gói tin cung cấp phương thức lấy danh sách các cơ quan tham gia xử lý thủ tục hành chính |
5 | Danh mục lĩnh vực thủ tục hành chính | LayDanhMucLinhVuc | Gói tin cung cấp phương thức lấy danh sách các lĩnh vực |
6 | Danh mục ngành | LayDanhMucNganh | Gói tin cung cấp phương thức lấy danh sách ngành |
7 | Danh mục Quốc gia/Quốc tịch | LayDanhMucQuocGia | Gói tin cung cấp phương thức lấy danh sách các Quốc gia/Quốc tịch |
II. Hướng dẫn kỹ thuật, mô tả chi tiết API
- Đường dẫn: http://lgsp.ungdungtructuyen.vn/RestService/forward/CommonService/GetData
- Method: POST
- Pre-request Script: xác thực tài khoản người dùng trước khi thực hiện lấy dữ liệu
o userName: tài khoản
o password: mật khẩu
o secretKey: khóa bí mật
const moment = require('moment');
var Header = require('postman-collection').Header
var userName = 'yourUsername';
var password = 'yourPassword';
var secretKey = 'yourSecretKey';
const user = btoa(`${userName}:${password}`)
var ts = moment().unix()*1000;
pm.request.headers.add(new Header('Timestamp:'+ ts));
pm.request.headers.add(new Header('secretKey:'+ secretKey));
pm.request.headers.add(new Header(`Authorization: Basic ${user}`));
- Input: Request body
STT | Tên trường | Định dạng | Bắt buộc | Mô tả |
1 | loaiDanhMuc | string | Có | mô tả loại danh mục cần lấy dữ liệu (mục I) |
2 | page | int | Không | thứ tự sau khi phân trang (mặc định là trang 1) |
3 | pageSize | int | Không | số bản ghi trên mỗi page (mặc định là 20 bản ghi) |
- Output:
Ghi chú:
error_code: 0 là thành công, 1 là thất bại
oGrid: dữ liệu được trả về sau khi được xử lý phân trang
+ Data: mảng dữ liệu được trả về
+ Total: tổng toàn bộ số bản ghi