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ụ

Phần mềm ISO điện tử khi có nhu cầu lấy chi tiết thông tin thủ tục hành chính thì sẽ gọi api lấy chi tiết thông tin thủ tục hành chính lên HCM LGSP (APITraCuuDanhMucHoSoKemTheoTheoMaThuTuc).
HCM LGSP sẽ lấy chi tiết thông tin thủ tục hành chính từ CSDL dùng chung của Thành phố và trả về chi tiết thông tin thủ tục hành chính 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 chi tiết thông tin thủ tục hành chính 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 chi tiết thông tin thủ tục hành chính 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

MÔ HÌNH KẾT NỐI
1. Mô hình kết nối lấy chi tiết danh mục thủ tục hành chính

Hình 1: Mô hình kết nối lấy chi tiết danh mục thủ tục hành chính

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ố.
APITraCuuDanhMucHoSoKemTheoTheoMaThuTuc hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy chi tiết thông tin Thủ tục hành chính 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ị.

ĐẶC TẢ API LẤY CHI TIẾT DANH MỤC THỦ TỤC HÀNH CHÍNH
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ụ 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	ewoiQWNjZXNzS2V5IjoiclRraFlDQndITSIsCiJTZWNyZXRLZ XkiOiJEV2tRZ1kxWVNTIiwKIkFwcE5hbWUiOiAiVFBIQ00iL AoiUGFydG5lckNvZGUiOiAiMDAwLjAwLjAxLkgyOSIsCiJQYX J0bmVyQ29kZUN1cyI6ICIwMDAuMDAuMDEuSDI5Igp9Cg== đượ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 cung cấp chi tiết danh mục thủ tục hành chính
Đường dẫn: /TraCuuThuTuc_GetHoSoKemTheoByMaThuTuc
Method: GET
Đầu vào:
- Header: Authorization
- Param:
  - MaThuTuc= 013002
Đầu ra:
- chuỗi json chứa thông tin trả về, resultObject là chuỗi json 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

{

"StatusCode": 200,

"Description": null,

"ResultObject": [{

"DinhDang": "application/msword",

"DanhSachDinhKem":[{…}],

"FileID": "122",

"KetQua": false,

"MaTaiLieu": "HSKT_001",

"TaiLieuID": "1cf21a8f-dbb3-435f-9c71-2768735db7f8",

"TenFile": "Mẫu đơn 01.doc",

"TenTaiLieu": "Hồ sơ kèm theo 01"

"MoTa": "Hồ sơ kèm theo 01"

}],

"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ài liệu kèm theo

STT	Tham số	Thuộc tính tham số	Mô tả	Yêu cầu
1	MaTaiLieu	String	Mã tài liệu	Bắt buộc
2	TenTaiLieu	String	Tên tài liệu	Bắt buộc
3	KetQua	Boolean	Kết quả thực hiện - False : hồ sơ kèm theo - True : kết quả thực hiện	Không bắt buộc
4	TenFile	String	Tên file đính kèm	Bắt buộc
5	FileID	String	Id file đính kèm	Bắt buộc
6	DinhDang	String	Định dạng file (Theo chuẩn MIME Types)	Bắt buộc
7	MoTa	String	Mô tả tệp đính kèm	Không bắt buộc
8	DanhSachDinhKem	JsonArray	Json tệp đính kèm của tài liệu tại *mục 3.4*	Không bắt buộc

Bảng 3: Gói tin tài liệu kèm theo

Ví dụ:

{