I. TỔNG QUAN

1. Mô tả nghiệp vụ

• Phần mềm ISO điện tử khi có nhu cầu lấy bộ danh mục phường xã thì sẽ gọi api lấy bộ danh mục phường xã lên HCM LGSP (APILayDanhMucPhuongXa).
• HCM LGSP sẽ lấy thông tin bộ danh mục phường xã từ CSDL dùng chung của Thành phố và trả về thông tin danh mục phường xã cho đơn vị.

2. Mục đích tài liệu

• Tài liệu này nhằm hướng dẫn đơn vị lấy thông tin danh mục phường xã từ CSDL tập trung của Thành phố.

3. Phạm vi và đối tượng áp dụng

• Tài liệu này được sử dụng bởi các kỹ thuật viên của các đơn vị cần lấy thông tin danh mục phường xã từ chuẩn CSDL dùng chung của Thành phố.

4. Thông tin kết nối

• Đơn vị cần kết nối liên hệ sở Thông tin và Truyền thông để được cung cấp thông tin kết nối bao gồm:
  • AppName
  • AccessKey
  • SecretKey

II. MÔ HÌNH KẾT NỐI

1. Mô hình kết nối lấy danh mục phường xã

Hình 1: Mô hình kết nối lấy bộ danh mục phường xã

• CSDL Dùng chung là nơi tập trung toàn bộ kho dữ liệu dùng chung của TPHCM. Cơ quan, tổ chức có thể thực hiện việc khai thác và đồng bộ dữ liệu về CSDL Dùng chung của Thành phố thông qua Nền tảng HCM LGSP.
• Nền tảng HCM LGSP đảm nhiệm vai trò chính trong việc cung cấp các thông tin kết nối đến các phần mềm tại đơn vị, khai thác và đồng bộ dữ liệu từ CSDL tập trung của thành phố.
• APILayDanhMucPhuongXa hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy bộ danh mục Phường xã chuẩn từ CSDL dùng chung của Thành phố.

2. Quá trình trao đổi gói tin

Hình 2: Quy trình trao đổi gói tin

• Bước 1: Phần mềm của đơn vị gọi đến Nền tảng HCM LGSP thông qua api kèm theo access token.
• Bước 2: Nền tảng HCM LGSP kiểm tra access token của đơn vị. Nếu thất bại sẽ trả về gói tin JSON lỗi cho phần mềm của đơn vị.
• Bước 3: Nền tảng HCM LGSP xử lý dữ liệu và trả về gói tin JSON kết quả cho phần mềm đơn vị.

III. ĐẶC TẢ API LẤY DANH MỤC PHƯỜNG XÃ

1. Thông tin kết nối

• Đơn vị đang trong giai đoạn thử nghiệm sẽ dùng hệ thống test theo địa chỉ apdapter Nền tảng HCM thử nghiệm
• Đơn vị khi có thông báo vận hành chính thức sẽ dùng hệ thống chính theo địa chỉ apdapter Nền tảng HCM chính

Bảng 1: bảng thông tin kết nối

2. API lấy danh mục phường xã

• Đường dẫn: /GetDanhMucPhuongXa
• Method: GET
• Đầu vào:
  • Header: Authorization
• Đầu ra:
  • chuỗi json chứa thông tin trả về, resultObject là chuỗi json array chứa thông tin danh mục, chi tiết dữ liệu tại mục 3.3

Bảng 2: tham số trả về của chuỗi json

Ví dụ:

3. Gói tin danh mục phường xã

Bảng 3: Gói tin danh mục phường xã

Ví dụ:

• DacTaLienThong_APICungCapDanhMucPhuongXa_v1.1.docx