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ố.
- APIDongBoTepDinhKem hỗ trợ phần mềm tại đơn vị kết nối vào Nền tảng HCM LGSP Đồng bộ dữ liệu Tệp đính kèm đơ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ộ tệp đính kèm 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ộ tệp đính kèm 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ộ tệp đính kèm
Hình 1: Mô hình kết nối đồng bộ tệp đính kèm
- 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ố.
- APIDongBoTepDinhKem hỗ trợ phần mềm tại đơn vị kết nối vào Nền tảng HCM LGSP Đồng bộ dữ liệu Tệp đính kèm đơ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Ộ TỆP ĐÍNH KÈM
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ộ tệp đính kèm
- Đường dẫn: /DongBoTepDinhKem
- 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
|
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
|
Base64
|
String
|
Lưu giá trị file đính kèm được mã hóa.
|
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
|
DinhDang
|
String
|
Định dạng file
(Theo chuẩn MIME Types)
|
Bắt buộc
|
Bảng 2: tham số truyền vào chuỗi json của body
Ví dụ:
|
{
"TenTepDinhKem": "DonDangKy.doc",
"DinhDang": "application/msword",
"MaHoSo":"SBN-0010",
"XacThuc":false,
"MaHoSoKemTheo":"SBN-0010-hskt001",
"MoTa":"Hồ sơ đính kèm đơn đăng ký",
"Base64":"0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7…",
}
|
- Đầ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
}
|