I. TỔNG QUAN
1. Mô tả nghiệp vụ
- Phần mềm ISO điện tử khi có nhu cầu lấy danh mục thủ tục hành chính thì sẽ gọi api lấy danh mục thủ tục hành chính lên HCM LGSP (APICungCapDanhMucThuTucHanhChinh).
- HCM LGSP sẽ lấy danh mục thủ tục hành chính từ CSDL dùng chung của Thành phố và trả về thủ tục hành chính tương ứng cho đơn vị.
2. Mục đích tài liệu
- Tài liệu này nhằm hướng dẫn đơn vị lấy danh mục thủ tục hành chính từ CSDL tập trung 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 lấy danh mục thủ tục hành chính từ chuẩn CSDL dùng chung của Thành phố.
4. 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
II. MÔ HÌNH KẾT NỐI
1. Mô hình kết nối cung cấp danh mục thủ tục hành chính
Hình 1: Mô hình kết nối lấy 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ố.
- APICungCapDanhMucThuTucHanhChinh 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ố..
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ị 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ị.
III. ĐẶC TẢ API CUNG CẤP DANH MỤC THỦ TỤC HÀNH CHÍNH
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 cung cấp danh mục thủ tục hành chính
- Đường dẫn: /GetDanhMucThuTuc
- Method: GET
- Đầu vào:
- Đầ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": [{
"CachThucThucHien": "- Trực tiếp ",
"CapThucHien": "- Bộ - Tỉnh",
"CoQuanCoThamQuyen": null,
"CoQuanCongBo": null,
"CoQuanDuocUyQuyen": null,
"CoQuanPhoiHop": null,
"CoQuanThucHien": null,
"DiaChiTiepNhan": null,
"DoiTuongThucHien": "Cá nhân",
"LePhi": "800000 VNĐ",
"LoaiTTHC": " TTHC cấp TW (Bộ ban hành, thực hiện)",
"MaLinhVuc": "046",
"MaNganh": null,
"MaThuTuc": "046002",
"MoTa": null,
"QuyetDinhCongBo": null,
"TenThuTuc": "Thủ tục cấp thẻ hướng dẫn viên du lịch quốc tế",
"ThoiHanGiaiQuyet": "15 ngày ",
"HoSoKemTheo": [{…}],
"KetQuaThucHien": [{…}],
"Used": 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 danh mục thủ tục hành chính
|
STT
|
Tham số
|
Thuộc tính tham số
|
Mô tả
|
Yêu cầu
|
|
1
|
MaThuTuc
|
String
|
Mã thủ tục hành chính gốc
|
Bắt buộc
|
|
2
|
TenThuTuc
|
String
|
Tên thủ tục hành chính
|
Bắt buộc
|
|
3
|
CoQuanCongBo
|
String
|
Cơ quan công bố, liên kết danh mục cơ quan
|
Bắt buộc
|
|
4
|
CapThucHien
|
String
|
Cấp thực hiện TTHC:
|
Bắt buộc
|
|
5
|
LoaiTTHC
|
String
|
Loại TTHC:
- 0 TTHC cấp TW (Bộ ban hành, thực hiện)
- 1 TTHC không được luật giao cho địa phương quy định hoặc quy định chi tiết (TTHC bộ ban hành, địa phương thực hiện)
- 2 TTHC được luật giao cho địa phương quy định hoặc quy định chi tiết (TTHC đặc thù của địa phương)
|
Bắt buộc
|
|
6
|
MaLinhVuc
|
String
|
Lĩnh vực, liên kết danh mục lĩnh vực
|
Bắt buộc
|
|
7
|
MaNganh
|
String
|
Mã ngành
|
Bắt buộc
|
|
8
|
CachThucThucHien
|
String
|
Cách thức thực hiện:
- 0 Trực tiếp
- 1 Trực tuyến
- 2 Bưu chính công ích
|
Bắt buộc
|
|
9
|
LePhi
|
String
|
Mức giá, phí, lệ phí thực hiện thủ tục hành chính
|
Bắt buộc
|
|
10
|
DoiTuongThucHien
|
String
|
Đối tượng thực hiện:
- 0 Cá nhân
- 1 Doanh nghiệp
- 2 Tổ chức
- 3 Cơ quan nhà nước
|
Bắt buộc
|
|
11
|
ThoiHanGiaiQuyet
|
String
|
Thời hạn giải quyết hồ sơ
|
Bắt buộc
|
|
12
|
CoQuanThucHien
|
String
|
Cơ quan thực hiện, liên danh mục cơ quan
|
Bắt buộc
|
|
13
|
CoQuanCoThamQuyen
|
String
|
Cơ quan có thẩm quyền quyết định, liên kết danh mục cơ quan
|
Bắt buộc
|
|
14
|
CoQuanDuocUyQuyen
|
String
|
Cơ quan được ủy quyền, liên kết danh mục cơ quan
|
Bắt buộc
|
|
15
|
DiaChiTiepNhan
|
String
|
Địa chỉ tiếp nhận, liên kết danh mục cơ quan
|
Bắt buộc
|
|
16
|
CoQuanPhoiHop
|
String
|
Cơ quan phối hợp, liên kết danh mục cơ quan
|
Bắt buộc
|
|
17
|
QuyetDinhCongBo
|
String
|
Quyết định công bố thủ tục hành chính
|
Bắt buộc
|
|
18
|
MoTa
|
String
|
Mô tả thủ tục hành chính
|
Không bắt buộc
|
|
19
|
HoSoKemTheo
|
JSON Array
|
Json tài liệu kèm theo lúc tiếp nhận tại mục 3.3
|
Không bắt buộc
|
|
20
|
KetQuaThucHien
|
JSON Array
|
Json tài liệu kèm theo lúc trả kết quả tại mục 3.4
|
Bắt buộc
|
|
21
|
Used
|
Boolean
|
Được sử dụng
|
Không bắt buộc
|
Bảng 3: gói tin danh mục thủ tục hành chính
Ví dụ:
{
"CachThucThucHien": "- Trực tiếp ",
"CapThucHien": "- Bộ - Tỉnh",
"CoQuanCoThamQuyen": null,
"CoQuanCongBo": null,
"CoQuanDuocUyQuyen": null,
"CoQuanPhoiHop": null,
"CoQuanThucHien": null,
"DiaChiTiepNhan": null,
"DoiTuongThucHien": "Cá nhân",
"LePhi": "800000 VNĐ",
"LoaiTTHC": " TTHC cấp TW (Bộ ban hành, thực hiện)",
"MaLinhVuc": "046",
"MaNganh": null,
"MaThuTuc": "046002",
"MoTa": null,
"QuyetDinhCongBo": null,
"TenThuTuc": "Thủ tục cấp thẻ hướng dẫn viên du lịch quốc tế",
"ThoiHanGiaiQuyet": "15 ngày ",
"HoSoKemTheo": [{…}],
"KetQuaThucHien": [{…}],
"Used": true
}
-
4. 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.5
|
Không bắt buộc
|
Bảng 4: Gói tin tài liệu kèm theo
Ví dụ:
{
"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"
}
-
5. Gói tin tệp đính kèm của tài liệu kèm
|
STT
|
Tham số
|
Thuộc tính tham số
|
Mô tả
|
Yêu cầu
|
|
1
|
TenFile
|
String
|
Tên file đính kèm
|
Bắt buộc
|
|
2
|
FileID
|
String
|
Id file đính kèm
|
Bắt buộc nếu Base64 không có
|
|
3
|
DinhDang
|
String
|
Định dạng file
(Theo chuẩn MIME Types)
|
Bắt buộc
|
|
4
|
MoTa
|
String
|
Mô tả tệp đính kèm
|
Không bắt buộc
|
Bảng 5: Gói tin tệp đính kèm của tài liệu kèm
Ví dụ:
{
"MoTa": "Hồ sơ kèm theo 01",
"FileID": "122",
"DinhDang": "application/msword",
"TenFile": "Mẫu đơn 01.doc",
}