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ố.
  • APIDongBoDanhGiaHaiLong 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 Đánh giá hài lòng tại đơn vị về CSDL dùng chung của Thành phố.
  • Phần mềm của đơn vị đóng gói dữ liệu về dạng JSON.

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

  • Tài liệu này nhằm hướng dẫn đơn vị đồng bộ thông tin đánh giá 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ộ thông tin đánh giá 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ộ đánh giá hài lòng

Hình 1: Mô hình kết nối đồng bộ thông tin đánh giá hài lòng

  • 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ố.
  • APIDongBoDanhGiaHaiLong 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 Đánh giá hài lòng tại đơn vị về CSDL dùng chung của Thành phố.
  1.  

2. Quá trình trao đổi gói tin đồng bộ đánh giá hài lòng

Hình 2: Quy trình trao đổi gói tin đánh giá hài lòng

  • 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 ĐÁNH GIÁ ĐỘ HÀI LÒNG

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

STT

Tên trường

Định Dạng

Đị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

QNI

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ộ đánh giá hài lòng

  • Mô tả:  Gói tin cung cấp phương thức đồng bộ số liệu thăm dò ý kiến người dùng về chất lượng DVC trực tuyến của các BNĐP lên Cổng DVC Quốc Gia.
  • Đường dẫn: /DongBoDanhGiaHaiLong
  • Method: POST
  • Đầu vào:
  • Header: Authorization
  • Body: chuỗi json chứa thông tin truyền vào

STT

Tên trường

Định Dạng

Mô tả

1

NgayTongHop

String

Ngày tng hợp số liệu thăm dò ý kiến, đánh giá chất lượng dịch vụ hành chính công.

Định dang: dd/MM/yyyyy

 Ví dụ: 18/07/2018.

2

LuotDanhGia

Int

Tổng số người tham gia đánh giá.

3

PhanTramDVRatHaiLong

Decimal

Phần trăm đánh giá dịch vụ là rất hài lòng.

4

PhanTramDVHaiLong

Decimal

Phần trăm đánh giá dịch vụ là hài lòng.

5

PhanTramDVChuaHaiLong

Decimal

Phần trăm đánh giá dịch vụ là chưa hài lòng.

6

ChiTietNoiDung

JSON Array

Json array Chi tiết nội dung thăm dò ý kiến tại mục 3.3

7

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 Cng 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ý

8

TenDonViC1

String

- Tên cơ quan, tổ chức là đầu mối kết nối với Cổng DVCQG (Bộ, tnh).

- Đầ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ý

9

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

 

10

TenDonViC2

String

Tên cơ quan, tổ chức là các sở, ngành, quận, huyện của TpHCM.

11

MaDonViC3

String

- Mã cấp III của cơ quan, tổ chức là các UBND phường, xã của TpHCM

12

TenDonViC3

String

Tên cơ quan, tổ chức là các UBND phường xã của TpHCM.

13

Version

String

Phiên bản của chuẩn gói tin

Bàng 2: thông tin các trường truyền vào chuỗi json của body

  • Đầ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

}         

  1.  

3. Gói tin chi tiết đánh giá hài lòng

STT

Tên trường

Định Dạng

Mô tả

Yêu Cầu

1

MaThuTuc

String

Ngày tổng hợp số liệu thăm dò ý kiến, đánh giá chất lượng dịch vụ hành chính công. Ví dụ: 18/7/2018.

Bắt buộc

2

NoiDungThamDo

String

Nội dung thăm dò.

Không bắt buộc

3

PhanTramDGRatHaiLong

Decimal

Phần trăm đánh giá là rất hài lòng.

 

4

PhanTramDGHaiLong

Decimal

Phần trăm đánh giá là hài lòng.

Bắt buộc

5

PhanTramDGChuaHaiLong

Decimal

Phần trăm đánh giá là chưa hài lòng.

Bắt buộc

Bảng 4: Gói tin chi tiết đánh giá hài lòng

Ví dụ:

{

  "MaThuTuc": "TT0001",

  "NoiDungThamDo": "Thăm dò ý kiến người dân ngày 18/07/2018" ,

  "PhanTramDGRatHaiLong": 50,

  "PhanTramDGHaiLong": 30,

  "PhanTramDGChuaHaiLong": 20,

}

Danh sách tệp tin đính kèm

  • DacTaLienThong_APIDongBoDanhGiaHaiLong_v1.1.docx