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ụ

Phần 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ố.
APIDongBoTrangThai 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 trạng thái hồ sơ từ Phần mềm Iso đơ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ộ trạng thái hồ sơ 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 trạng thái hồ sơ 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ộ trạng thái hồ sơ

Hình 1: Mô hình kết nối đồng bộ trạng thái hồ sơ

Phần 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ố.
APIDongBoTrangThai 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 trạng thái hồ sơ từ Phần mềm Iso đơ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Ộ TRẠNG THÁI

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ộ trạng thái hồ sơ

Đường dẫn: /DongBoTrangThai
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 ý
	HoSoMotCuaID	String	Mã định danh của hồ sơ tại phần mềm một cửa	Bắt buộc
	MaTrangThaiHoSo	String	Mã của gói tin trạng thái. Phần mềm tự phát sinh duy nhất trong một hồ sơ	Bắt buộc
	TrangThaiHoSo	String	Mã trạng thái xử lý của hồ sơ. Tham khảo Bảng 2 Ví dụ: SUBMITED	Bắt buộc
	NgayKetThucTTTruoc	String	Ngày kết thúc của trạng thái trước Đinh dạng: dd/mm/yyyy hh:mm:ss Ví du: 15/09/2016 15:30:15	Không bắt buộc
	NgayXuLy	String	Ngày bắt đầu xử lý trạng thái hiện tại Đinh dạng: dd/mm/yyyy hh:mm:ss Ví du: 15/09/2016 15:30:15	Bắt buộc
	HanXuLy	String	Hạn xử lý của trạng thái Kiểu Date: dd/MM/yyyy hh:mm:ssz Ví dụ: 16/09/2016 15:30:16	Không bắt buộc
	MaNguoiXuLy	String	Mã chuyên viên đang xử lý hồ sơ	Không bắt buộc
	TenNguoiXuLy	String	Họ và tên chuyên viên đang xử lý hồ sơ	Bắt buộc
	PhongBanNguoiXuLy	String	Phòng ban của chuyên viên đang xử lý hồ sơ	Không bắt buộc
	ChucVuNguoiXuLy	String	Chức vụ của chuyên viên đang xử lý hồ sơ	Bắt buộc
	NoiDungXuLy	String	Mô tả nội dung xử lý	Không bắt buộc
	NgayHenTra	String	Ngày hẹn trả hồ sơ Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc khi trạng thái là: VERIFIED
	SoBienNhan	String	Số biên nhận của hồ sơ tại phần mềm ISO	Bắt buộc khi trạng thái là: VERIFIED
	MaHoSo	String	Mã hồ sơ	Bắt buộc khi trạng thái là: VERIFIED
	PhiDichVu	String	Phí dịch vụ công	Bắt buộc khi trạng thái là: PAYMENT_REQUEST
	NgayThanhToan	String	Ngày thanh toán thành công Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc khi trạng thái là: PAID
	MaGiaoDich	String	Mã giao dịch	Bắt buộc khi trạng thái là: PAID hay PAYMENT_REQUEST
	NgayYeuCauThanhToan	String	Ngày yêu cầu thanh toán Kiểu Date: dd/MM/yyyy hh:mm:ss Ví dụ: 16/09/2016 15:30:16	Bắt buộc khi trạng thái là: PAYMENT_REQUEST
	Ticket	String	Mã định danh của hồ sơ nộp qua mạng. Dùng để xác định hồ sơ qua mạng khi trao đổi thông tin giữa các phần mềm với nhau. Hồ sơ phát sinh từ phần mềm nào thì phần mềm đó sinh một mã định danh duy nhất trong phần mềm đó để trao đổi qua mạng. Phần mềm nên đặt ticket theo cấu trúc sau:[Mã đơn vị] [Năm nhận hồ sơ][Mã lĩnh vực][Mã thủ tục][Số thứ tự hồ sơ] Lưu ý: Hồ sơ đã có ticket ( hồ sơ nhận từ cổng DVC) thì giữ nguyên giá trị ticket.	Bắt buộc
	MaDonViC1	String	- Mã cấp I của cơ quan, tổ chức là đầu mối (Bộ, tỉnh...) kết nối với Cổng DVCQG - Đối với các Bộ, tỉnh: sử dụng mã cấp 1 theo QCVN 102:2016/BTTTT. - Đầu mối hiện tại là Nền tảng HCM LGSB do Sở Thông tin và truyền thông HCM quản lý	Bắt buộc MaDonViC1 = "30.98.H29"
	TenDonViC1	String	-Tên cơ quan, tổ chức là đầu mối kết nối với Cổng DVCQG (Bộ, tỉnh). - Đầu mối hiện tại là Nền tảng HCM LGSB do Sở Thông tin và truyền thông HCM quản lý	Bắt buộc TenDonViC1= "Sở Thông tin và Truyền thông"
	MaDonViC2	String	- Mã cấp II của cơ quan, tổ chức là các sở, ngành, quận, huyện của TpHCM	Bắt buộc
	TenDonViC2	String	Tên cơ quan, tổ chức là các sở, ngành, quận, huyện của TpHCM.	Bắt buộc
	MaDonViC3	String	- Mã cấp III của cơ quan, tổ chức là các UBND phường, xã của TpHCM	Bắt buộc
	TenDonViC3	String	Tên cơ quan, tổ chức là các UBND phường xã của TpHCM.	Bắt buộc
	Version	String	Phiên bản của chuẩn gói tin	Bắt buộc

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

Ví dụ:

{

"HoSoMotCuaID": "HSMC-00001",

"MaHoSo": "SBN-0010",

"NguoiXuLy": "Nguyễn Văn Thảo",

"PhongBanNguoiXuLy": "Phòng ban 01",

"ChucVuNguoiXuLy": "Chuyên viên",

"NgayXuLy": "15/09/2016 15:30:15",

"NgayHenTra": "20/09/2016 15:30:15",

"NoiDungXuLy": "Thẩm định hồ sơ",

"NgayKetThucTTTruoc": "15/09/2016 15:30:15",

"HanXuLy": "16/09/2016 8:30:15",

"MaTrangThaiHoSo": " SUBMITED12345",

"TrangThaiHoSo": "SUBMITED",

"MaDonViC1": "38.98.H29",

"TenDonViC1": "Sở Du lịch TP.HCM",

"MaDonViC2": null,

"TenDonViC2": null,

"MaDonViC3": null,

"TenDonViC3": null,

"Version": "v1.0",

"Ticket":"38.98.H292019046046002010"

}

Đầ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	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 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. Danh sách các bảng mã liên quan tới gói tin hồ sơ

STT	Mã trạng thái	Tên trạng thái	Mô tả
1	CREATED	Vừa tiếp nhận trực tuyến	Vừa tiếp nhận trực tuyến.
2	VERIFIED	Đã tiếp nhận hồ sơ	Vừa tiếp nhận hồ sơ tại đơn vị. Cổng DVC khóa chức năng hiệu chỉnh hồ sơ trên Cổng . ISO tại đơn vị tiếp nhận hồ sơ nếu cùng “ticket” chỉ tiếp nhận hồ sơ có thời gian gửi lên Nền tảng HCM gần nhất. Cổng DVC chuyển gói tin hồ sơ cho Bưu điện nếu người dân có đăng ký dịch vụ: “Nộp hồ sơ tại nhà” hoặc “Nộp và nhận kết quả hồ sơ tại nhà” khi nộp hồ sơ trực tuyến. Bưu điện nhận gói tin hồ sơ, tiến hành thu gom hồ sơ của người dân và chuyển cho đơn vị thụ lý.
3	SUBMITED	Đang xử lý	Đang xử lý, đang chờ duyệt, ... Bao gồm tất cả các trạng thái trong quá trình xử lý trừ: Đã tiếp nhận, chờ bổ sung, hoàn thành, không giải quyết, hủy hồ sơ (xóa, hoặc chủ hồ sơ lên rút lại).
4	REJECTED	Từ chối tiếp nhận hồ sơ	Từ chối tiếp nhận hồ sơ. Cổng DVC mở chức năng hiệu chỉnh hồ sơ trên Cổng DVC để người dân có thể hiệu chỉnh/bổ sung hồ sơ. Sau đó tạo gói tin hồ sơ gửi đến ISO đơn vị (vẫn giữ “ticket” cũ để ISO tại đơn vị cập nhật thông tin hồ sơ).
5	COMPLETED	Hoàn thành hồ sơ	Hoàn thành (cấp phép). Cổng DVC chuyển gói tin trạng thái Hoàn thành cho Bưu điện nếu người dân có đăng ký dịch vụ: “Nhận kết quả hồ sơ tại nhà” hoặc “Nộp và nhận kết quả hồ sơ tại nhà” khi nộp hồ sơ trực tuyến. Bưu điện nhận gói tin trạng thái, tiến hành nhận kết quả hồ sơ tại đơn vị và chuyển cho cho người dân.
7	PUBLISHED	Đã trả kết quả cho công dân	Đã trả hồ sơ cho dân.
8	NEED_INPUT_DATA	Cần bổ sung hồ sơ	Chờ bổ sung hồ sơ. Cổng DVC mở chức năng hiệu chỉnh hồ sơ trên Cổng DVC để người dân có thể hiệu chỉnh/bổ sung hồ sơ. Sau đó tạo gói tin hồ sơ gửi đến ISO đơn vị (vẫn giữ “ticket” cũ để ISO tại đơn vị cập nhật thông tin hồ sơ).
9	COMPLETED_INPUT_DATA	Đã bổ sung hồ sơ	Hồ sơ đã được nhận bổ sung.
10	ERROR	Lỗi xử lý gói tin	Phần mềm ISO nhận gói tin về bị lỗi do cấu trúc gói tin không đúng thì gửi trạng thái này lại cho DVC để phục vụ hiệu chỉnh phần mềm.
11	CANCEL	Hủy hồ sơ	Sử dụng trong trường hợp xóa, hoặc chủ hồ sơ lên rút lại.
12	PAYMENT_REQUEST	Yêu cầu thanh toán	Phần mềm ISO gửi yêu cầu thanh toán cho DVC
13	PAID	Đã thanh toán	DVC cập nhật trạng thái đã thanh toán cho phần mềm ISO

Bảng 4: Bảng mã trạng thái sử lý hồ sơ

STT	Mã trạng thái	Tên trạng thái	Mô tả
1	POST01	Đã nhận thông tin hồ sơ cần thu gom	Bưu điện đã nhận gói tin hồ sơ từ Cổng DVC
2	POST02	Thu gom hồ sơ thành công	Bưu điện nhận tin và tiến hành đến địa chỉ người/ cơ quan nộp hồ sơ để thu gom hồ sơ thành công
3	POST03	Thu gom hồ sơ thất bại	Bưu điện nhận tin và tiến hành đến địa chỉ người/ cơ quan nộp hồ sơ để thu gom hồ sơ nhưng thất bại
4	POST04	Nộp hồ sơ cho Cơ quan hành chính thành công	Bưu điện chuyển giao nộp hồ cho cơ quan hành chính thành công
5	POST05	Nộp hồ sơ cho Cơ quan hành chính thất bại	Bưu điện chuyển giao nộp hồ cho cơ quan hành chính nhưng thất bại. Trường hợp sau khi Cơ quan hành chính đã tiếp nhận hồ sơ nộp qua Bưu điện, sau đó phát hiện hồ sơ thiếu/sai chứng từ và có yêu cầu người nộp bổ sung chứng từ: CQ hành chính phải thông báo cho người dân (qua web hoặc bằng văn bản). Khi đó, nếu người dân có nhu cầu nộp chứng từ bổ sung qua đường Bưu điện thì đăng ký dịch vụ như quy trình gửi tin ban đầu.
6	POST06	Chuyển hoàn hồ sơ lại cho người nộp	Chuyển hoàn hồ sơ lại cho người nộp. (Trường hợp cơ quan hành chính từ chối nhận)
7	POST07	Nhận kết quả từ Cơ quan hành chính thành công	Bưu điện nhận kết quả giải quyết hồ sơ từ cơ quan hành chính: Kết quả Hoàn thành
8	POST08	Nhận thông báo bổ sung/điều chỉnh hồ sơ từ Cơ quan hành chính	Bưu điện nhận kết quả giải quyết hồ sơ từ cơ quan hành chính: Nhận thông báo bổ sung/điều chỉnh hồ sơ từ Cơ quan hành chính
9	POST09	Phát kết quả hồ sơ cho Người dân lần 1 thành công	Bưu điện phát kết quả hồ sơ cho Cơ quan/Người dân lần 1 thành công
10	POST10	Phát kết quả hồ sơ cho Người dân lần 1 thất bại	Bưu điện phát kết quả hồ sơ cho Cơ quan/Người dân lần 1 thất bại
11	POST11	Phát kết quả hồ sơ cho Người dân lần 2 thành công	Bưu điện phát kết quả hồ sơ cho Cơ quan/Người dân lần 2 thành công
12	POST12	Phát kết quả hồ sơ cho Người dân lần 2 thất bại	Bưu điện phát kết quả hồ sơ cho Cơ quan/Người dân lần 2 thất bại
13	POST13	Chuyển hoàn kết quả hồ sơ cho Cơ quan hành chính	Chuyển hoàn kết quả giải quyết hồ sơ lại cho cơ quan hành chính (Nếu 2 lần phát không thành công)

Bảng 5: Bảng mã trạng thái bưu điện

STT	Mã trạng thái	Tên trạng thái	Mô tả
1	01	Nộp hồ sơ tại nhà	Bưu điện đến thu gom hồ sơ tại nhà nộp cho cơ quan hành chính
2	02	Nhận kết quả hồ sơ tại nhà	Bưu điện nhận kết quả tại cơ quan hành chính và phát trả kết quả tại nhà
3	03	Nộp và nhận kết quả hồ sơ tại nhà	Bưu điện đến thu gom hồ sơ tại nhà nộp cho cơ quan hành chính và nhận kết quả tại cơ quan hành chính, phát trả kết quả tại nhà