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

TỔNG QUAN
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ố.
APICungCapThongTinTepDinhKemHoSoBoSungTheoMaHoSo hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy Thông tin hồ sơ chuẩn từ CSDL dùng chung của Thành phố.
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.
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ị.
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ị.
1. Mục đích tài liệu
Tài liệu này nhằm hướng dẫn 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ố.
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 cung cấp thông tin hồ sơ về CSDL dùng chung của Thành phố.

MÔ HÌNH KẾT NỐI
1. Mô hình gói tin

Hình 1: Mô hình kết kết cung cấp thông tin hồ sơ

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ố.
APICungCapThongTinTepDinhKemHoSoBoSungTheoMaHoSo hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy Thông tin hồ sơ 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

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.
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ị.
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 THÔNG TIN ĐÍNH KÈM HỒ SƠ BỔ SUNG
1. Thông tin kết nối

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ụ dự kiến chính thức	https://hcmesb.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.tphcm.gov.vn/test
AccessKey	Khóa	rTkhYCBwHM
SecretKey	Khóa bí mật	DWkQgY1YSS
AppName	Đơn vị kết nối	TPHCM
Authorization/Token	Khai báo trong Header, Là chuỗi gồm 3 tham số dạng json được mã hóa thành StringBase64	eyJhcHAiOiJRTkkiLCJzZWNyZXQiOiJEV2tRZ1kxWVNTIiwia2V5IjoiclRraFlDQndITSJ9 được stringbase64 từ: { "AccessKey":"rTkhYCBwHM", "SecretKey":"DWkQgY1YSS", "AppName": "TPHCM" }

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

1. API tra cứu thông tin đính kèm hồ sơ bổ sung
Đường dẫn: /TraCuuHoSo_GetTepDinhKemHoSoBoSungByMaHoSo
Method: GET

Đầu vào:
- Header: Authorization
- Parram: MaHoSo=00.0H49.000001
Đầu ra:
- chuỗi json chứa thông tin trả về, resultObject là chuỗi json thông tin, 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	JSON	Chuỗi json 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

{

"StatusCode": 200,

"Description": null,

"ResultObject": [{

"TenTepDinhKem": "DonDangKy.doc",

"DinhDang": "application/msword",

"MoTa": "",

"MaHoSo":"SBN-0010",

"XacThuc":false,

"MaHoSoKemTheo":"SBN-0010-hskt001",

"MoTa":"Hồ sơ đính kèm đơn đăng ký",

"FileID":"0001",

"BoSungID":"0001",

}],

"ResultType": "JSON",

"Status": "SUCCESS",

"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 tệp đính kèm của hồ sơ bổ sung

STT	Tên trường	Định Dạng	Mô tả	Yêu cầu
1	TenTepDinhKem	String	Tên file đính kèm.	Bắt buộc
2	MaHoSoKemTheo	String	Mã hồ sơ kèm theo	Không bắt buộc
3	MaHoSo	String	Mã hồ sơ	Bắt buộc
4	FileID	String	Mã tệp đính kèm trên hệ thống DIP.	Bắt buộc
5	XacThuc	Boolean	Các tệp (thành phần hồ sơ) đính kèm gắn liền với hồ sơ của người sử dụng đã được xác thực.	Bắt buộc
6	MoTa	String	Mô tả tệp đính kèm	Không bắt buộc
7	BoSungID	String	Mã hồ sơ bổ sung tại phần mềm một cửa	Bắt buộc
8	DinhDang	String	Định dạng file (Theo chuẩn MIME Types)	Bắt buộc

Bảng 3: Gói tin tệp đính kèm của hồ sơ bổ sung

Ví dụ:

{

"TenTepDinhKem": "DonDangKy.doc",

"DinhDang": "application/msword",

"MoTa": "",

"MaHoSo":"SBN-0010",

"XacThuc":false,

"MaHoSoKemTheo":"SBN-0010-hskt001",

"MoTa":"Hồ sơ đính kèm đơn đăng ký",

"FileID":"0001",

"BoSungID":"0001",

}

Danh sách tệp tin đính kèm

15.DacTaLienThong_APICungCapThongTinTepDinhKemHoSoBoSungTheoMaHoSo_v1.1.docx

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

Danh sách tệp tin đính kèm

API Cung cấp thông tin tệp đính kèm hồ sơ bổ sung theo mã hồ sơ

Câu hỏi thường gặp

CHÚNG TÔI LUÔN SẴN
SÀNG ĐỂ GIÚP ĐỠ BẠN

Để được hỗ trợ tốt nhất. Hãy gọi

SỞ THÔNG TIN VÀ TRUYỀN THÔNG TPHCM

LIÊN KẾT WEBSITE

KẾT NỐI VỚI CHÚNG TÔI

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

Danh sách tệp tin đính kèm

API Cung cấp thông tin tệp đính kèm hồ sơ bổ sung theo mã hồ sơ

Câu hỏi thường gặp

CHÚNG TÔI LUÔN SẴN SÀNG ĐỂ GIÚP ĐỠ BẠN

Để được hỗ trợ tốt nhất. Hãy gọi

CHÚNG TÔI LUÔN SẴN
SÀNG ĐỂ GIÚP ĐỠ BẠN