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

I. 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ố.
APIDongBoHoSoBoSung hỗ trợ phần mềm ISO tại đơn vị kết nối vào Nền tảng HCM LGSP Đồng bộ dữ liệu Hồ sơ bổ sung tại đơn vị về CSDL dùng chung của Thành phố.

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

Tài liệu này nhằm hướng dẫn đơn vị đồng bộ hồ sơ bổ sung về CSDL dùng chung 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 đồng bộ hồ sơ bổ sung về CSDL dùng chung của Thành phố.

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

1. Mô hình kết nối đồng bộ hồ sơ bổ sung

Hình 1: Mô hình kết nối đồng bộ 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ố.
APIDongBoHoSoBoSung hỗ trợ phần mềm ISO tại đơn vị kết nối vào Nền tảng HCM LGSP Đồng bộ dữ liệu Hồ sơ bổ sung tại đơn vị về 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ị đó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ị.

III. ĐẶC TẢ API ĐỒNG BỘ THÔNG TIN HỒ SƠ BỔ SUNG

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

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

2. API đồng bộ thông tin hồ bổ sung

Đường dẫn: /DongBoHoSo
Method: POST
Đầu vào:
Header: Authorization
Body: chuỗi json chứa thông tin truyền vào

STT	Tham số	Thuộc tính tham số	Mô tả	Lưu ý
1	ID	String	Id của Yêu cầu bổ sung trong hệ thống Cơ quan thụ lý.	Bắt buộc
2	NguoiYeuCauBoSung	String	Người gửi yêu cầu bổ sung.	Bắt buộc
3	NoiDungBoSung	String	Nội dung yêu cầu bổ sung.	Bắt buộc
4	NgayYeuCauBoSung	String	Ngày gửi yêu cầu bổ sung. Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc
5	NguoiTiepNhanBoSung	String	Người tiếp nhận Bổ sung hồ sơ từ công dân.	Không bắt buộc
6	ThongTinTiepNhan	String	Thông tin tiếp nhận. Ví dụ: Ông Nguyễn Văn A đã bổ sung đầy đủ ...	Không bắt buộc
7	NgayTiepNhanBoSung	String	Ngày tiếp nhận bổ sung hồ sơ. Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc nếu TrangThaiBoSung = true
8	TrangThaiBoSung	Boolean	Trạng thái bổ sung hồ sơ: - True: Công dân đã bổ sung đầy đủ thủ tục hồ sơ; - False: Công dân không bổ sung hồ sơ (quá hạn bổ sung); - Null: Công dân chưa tới bổ sung hồ sơ (còn hạn).	Bắt buộc
9	LePhiBoSungs	JSON Array	Json danh sách lệ phí tại mục 3.3	Không bắt buộc
10	GiayToBoSungs	JSON Array	Json danh sách giấy tờ thu kèm theo hồ sơ một cửa tại mục 3.4	Không bắt buộc
11	NgayHenTraTruoc	String	Ngày hẹn trả trước khi bổ sung. Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc
12	NgayHenTraMoi	String	Ngày hẹn trả mới sau khi bổ sung hồ sơ. Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Không bắt buộc
13	SoLuongDinhKem	Int	Số lượng file đính kèm bổ sung	Không bắt buộc

Bảng 2: tham số truyền vào chuỗi json của body

Ví dụ:

Chuỗi json

{

"HoSoBoSungID ": 100,

"NguoiYeuCauBoSung": "Nguyễn Văn A",

"NoiDungBoSung": "Bổ sung bản sao CMND",

"NgayYeuCauBoSung": "16/09/2016 15:30:16",

"NguoiTiepNhanBoSung": "Nguyễn Văn A",

"ThongTinTiepNhan": "Ông Nguyễn Văn A đã bổ sung hồ sơ đầy đủ",

"NgayTiepNhanBoSung": "16/09/2016 15:30:16",

"TrangThaiBoSung": true

"NgayHenTraTruoc": "16/09/2016 15:30:16",

"NgayHenTraMoi": "16/09/2016 15:30:16",

"SoLuongDinhKem": 2,

"LePhiBoSungs": [{

"Gia": 1000000,

"LoaiLePhi": 1,

"TenLePhi": "Lệ phí bổ sung"

}],

"GiayToBoSungs": [{

"SoLuong": 1,

"LoaiGiayTo": 1,

"TenGiayTo": "Bản sao CMND"

}],

}

Đầu ra:
Chuỗi json chứa thông tin trả về, resultObject là true hoặc false

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 3: tham số trả về của chuỗi json

Ví dụ:

Thành công

Lỗi

{

"StatusCode": 200,

"Description": null,

"ResultObject": true,

"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

}

3. Gói tin lệ phí

STT	Tên trường	Định Dạng	Mô tả	Yêu cầu
1	TenLePhi	String	Tên Lệ phí.	Bắt buộc
2	Gia	Decimal	Số tiền thu.	Bắt buộc
3	LoaiLePhi	Int	Loại Lệ phí thu: - 1: Lệ phí thu khi tiếp nhận hồ sơ; - 2: Lệ phí thu khi bổ sung hồ sơ; - 4: Lệ phí thu khi trả kết quả.	Bắt buộc

Bảng 4: Gói tin lệ phí

Ví dụ:

Chuỗi json

{

"Gia": 1000000,

"LoaiLePhi": 1,

"TenLePhi": "Lệ phí hồ sơ"

}

4. Gói tin giấy tờ thu kèm

STT	Tên trường	Định Dạng	Mô tả	Yêu cầu
1	TenGiayTo	String	Tên giấy tờ.	Bắt buộc
2	SoLuong	Int	Số lượng.	Bắt buộc
3	LoaiGiayTo	Int	Loại giấy tờ thu: - 1: Giấy tờ thu khi tiếp nhận hồ sơ; - 2: Giấy tờ thu khi bổ sung hồ sơ; - 4: Giấy tờ thu khi trả kết quả.	Bắt buộc