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ố

Giải pháp thực hiện

1. Mô tả nghiệp vụ
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ố.

APITraCuuTruSoKinhDoanh hỗ trợ phần mềm tại đơn vị kết nối vào Nền tảng HCM LGSP tra cứu trụ sở kinh doanh từ CSDL dùng chung của Thành phố
1. Mục đích tài liệu

Tài liệu này nhằm hướng dẫn đơn vị tra cứu trụ sở kinh doanh về CSDL dùng chung 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 tra cứu trụ sở kinh doanh về CSDL dùng chung của Thành phố.

MÔ HÌNH KẾT NỐI
1. Mô hình kết nối tra cứu trụ sở kinh doanh

Hình 1: Mô hình kết nối tra cứu trụ sở kinh doanh

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ố.
APITraCuuTruSoKinhDoanh hỗ trợ phần mềm tại đơn vị kết nối vào Nền tảng HCM LGSP tra cứu trụ sở kinh doanh 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ị đóng gói dữ liệu về dạng JSON.
Bước 2: 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 3: 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 4: 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ị.

ĐẶC TẢ API TRA CỨU TRỤ SỞ KINH DOANH
1. Thông tin kết nối

Kiểu	Diễn giải	Ví dụ
Địa chỉ adapter Nền tảng HCM thử nghiệm	Địa chỉ cổng dịch vụ chính thức	https://hcmesb-test.tphcm.gov.vn
Địa chỉ adapter Nền tảng HCM chính	Địa chỉ cổng dịch vụ thử nghiệm	https://hcmlgsp.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	ewoiQWNjZXNzS2V5IjoiclRraFlDQndITSIsCiJTZWNyZXRLZXkiOiJEV2tRZ1kx WVNTIiwKIkFwcE5hbWUiOiAiVFBIQ00iLAoiUGFydG5lckNvZGUiOiAiMDAw LjAwLjAxLkgyOSIsCiJQYXJ0bmVyQ29kZUN1cyI6ICIwMDAuMDAuMDEuSDI5 Igp9Cg== đượ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 tra cứu trụ sở kinh doanh
Đường dẫn: /TraCuuTruSoKinhDoanh
Method: GET
Đầu vào:
- Header: Authorization
- Param:
  - MaSoDoanhNghiep : string
Đầu ra:
- Chuỗi json chứa thông tin trả về

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	JSON Array	Chuỗi json trả về tại mục 3.3
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": [

{

"FULL_TEXT": "Tòa nhà EMall, Lô J1.20b-21, đường số 7, khu Thương mại Nam, Khu Chế xuất Tân Thuận, Phường Tân Thuận Đông, Quận 7, Thành phố Hồ Chí Minh, Việt Nam",

"HO_EMAIL": "ferrarivn2019@gmail.com",

"HO_FAX": null,

"HO_PHONE": "+84 28 3662 0770",

"HO_URL": null,

"STREET_NUMBER": "Tòa nhà EMall, Lô J1.20b-21, đường số 7, khu Thương mại Nam, Khu Chế xuất Tân Thuận"

}

"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

}

1. Gói tin trụ sở kinh doanh

STT	Tên trường	Định Dạng	Mô tả
	HO_PHONE	String	Số điện thoại doanh nghiệp
	HO_FAX	String	Số Fax của doanh nghiệp
	HO_EMAIL	String	Email của doanh nghiệp
	HO_URL	String	Website của doanh nghiệp
	STREET_NUMBER	String	Địa chỉ đường của doanh nghiệp
	FULL_TEXT	String	Địa chỉ đầy đủ của doanh nghiệp