Nền tảng tích hợp, chia sẻ liên thông kết nối chính quyền điện tử thành phố

Phần mềm ISO điện tử khi có nhu cầu lấy bộ danh mục quan hệ thì sẽ gọi api lấy bộ danh mục quan hệ lên HCM LGSP (APILayDanhMucQuanHe).
HCM LGSP sẽ lấy thông tin bộ danh mục quan hệ từ CSDL dùng chung của Thành phố và trả về thông tin danh mục quan hệ cho đơn vị.
1. 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 quan hệ từ CSDL tập trung của Thành phố.
1. 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 quan hệ từ chuẩn CSDL dùng chung của Thành phố.
1. 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

Hình 1: Mô hình kết nối lấy bộ danh mục quan hệ

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ố.
APILayDanhMucQuanHe hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy bộ danh mục Quan hệ chuẩn từ CSDL dùng chung của Thành phố.
1. 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ị.

Kiểu	Diễn giải	Ví dụ
Địa chỉ adapter Nền tảng HCM chính	Địa chỉ cổng dịch vụ chính thức	https://hcmlgsp.tphcm.gov.vn
Địa chỉ adapter Nền tảng HCM thử nghiệm	Địa chỉ cổng dịch vụ thử nghiệm	https://hcmesb-test.tphcm.gov.vn
AccessKey	Khóa	rTkhYCBwHM
SecretKey	Khóa bí mật	DWkQgY1YSS
AppName	Đơn vị kết nối	TPHCM
PartnerCode	Mã đơn vị cung cấp ứng dụng	000.00.01.H29
PartnerCodeCus	Mã đơn vị sử dụng dịch vụ	000.00.01.H29
Authorization	Khai báo trong Header, Là chuỗi gồm 5 tham số dạng json được mã hóa thành StringBase64	ewoiQWNjZXNzS2V5IjoiclRraFlD QndITSIsCiJTZWNyZXRLZXkiOiJEV2tRZ1kx WVNTIiwKIkFwcE5hbWUiOi AiVFBIQ00iLAoiUGFydG5lckNvZGUiOiAiMD AwLjAwLjAxLkgyOSIsCiJQYXJ0bmVyQ29kZUN1cyI6ICIwMD AuMDAuMDEuSDI5Igp9Cg== được stringbase64 từ: { "AccessKey":"rTkhYCBwHM", "SecretKey":"DWkQgY1YSS", "AppName": "TPHCM", "PartnerCode": "000.00.01.H29", "PartnerCodeCus": "000.00.01.H29" }

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

1. API lấy danh mục quan hệ
Đường dẫn: /GetDanhMucQuanHe
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

STT	Tham số	Thuộc tính tham số	Mô tả
1	StatusCode	Int	Mã trạng thái gói tin - 200: Request đã được tiếp nhận và xử lý thành công - 400: Request bị lỗi hoặc không thể xử lý - 404: Tài nguyên không tồn tại - 500: Lỗi trong quá trình xử lý
2	Description	String	Nội dung lỗi trả về
3	ResultObject	Boolean	Kết quả trả về
4	ResultType	String	Type của gói tin trả về Mặc định là “JSON”
5	Status	String	Trạng thái gói tin“SUCCESS” hoặc “FAIL”
6	ThrowException	bool	Có lỗi xảy ra hay không

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

Ví dụ:

Thành công

Lỗi

{

"Description": null,

"ResultObject": [

{

"Ma": "00",

"MoTa": null,

"Ten": "Chưa có thông tin",

"Used": true

{

"Ma": "01",

"MoTa": null,

"Ten": "Ông",

"Used": true

}

"ResultType": "JSON",

"Status": "SUCCESS",

"StatusCode": 200,

"ThrowException": false

}

{

"StatusCode": 500,

"Description": "Tham số đầu vào không đúng",

"ResultObject": null,

"ResultType": null,

"Status": "FAIL",

"ThrowException": true

}