Giải pháp thực hiện

  1.  

1.Mô hình gói tin

  • 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 trục LGSP.
  • Trục 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ố.
  • APIDongBoThongKeTongHop hỗ trợ phần mềm tại đơn vị kết nối vào trục LGSP Đồng bộ dữ liệu Thống kê tổng hợp từ đơn vị về CSDL dùng chung của Thành phố.

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 trục LGSP thông qua api kèm theo access token.
  • Bước 3: Trục 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: Trục LGSP xử lý dữ liệu và trả về gói tin JSON kết quả cho phần mềm đơn vị.

3.Thông tin kết nối

Kiểu

Diễn giãi

Ví dụ

Địa chỉ adapter trục chính

Địa chỉ cổng dịch vụ dự kiến chính thức

https://hcmesb.tphcm.gov.vn

Địa chỉ adapter trục thử nghiệm

Địa chỉ cổng dịch vụ thử nghiệm

https://hcmesb.tphcm.gov.vn

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”

}

  •  

4.API đồng bộ thống kê tổng hợp

  • Đường dẫn: /DongBoThongKeTongHop
  • Method: POST
  • Input:
    • Header: Authorization
    • Body: chuỗi json chứa thông tin truyền vào tại 5.2,
  • Ouput: chuỗi json chứa thông tin trả về tại mục 5.1, resultObject là true hoặc false

5.Định dạng gói tin

  1. Gói tin trả về

STT

Tên trường

Định dạng

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

Ví dụ:

{

    "StatusCode": 500,

    "description": "Tham số đầu vào không đúng",

    "resultObject": null,

    "resultType": null,

    "status": "FAIL",

    "throwException": true

}

Ví dụ khác:

{

    "StatusCode": 200,

    "description": null,

    "resultObject": true,

    "resultType": "JSON",

    "status": "SUCCESS",

    "throwException": false

}

      1. Gói tin thống kê tổng hợp

STT

Tên trường

Định dạng

Mô tả

Yêu cầu

1

Thang

Int

Tháng lấy số liệu.

Bắt buộc

2

Nam

Int

Năm lấy số liệu.

Bắt buộc

3

IsThang

Boolean

Giá trị xác định số liệu thng kê theo tháng hoặc năm.

Bt buộc

4

NhanTrongKy

Int64

Số hồ sơ nhận trong kỳ.

Bắt buộc

5

TonKyTruoc

Int64

Số hồ sơ tồn kỳ trước chuyn sang.

Bt buộc

6

TongXuLy

Int64

Tổng số hồ sơ xử lý trong kỳ.

Bt buộc

7

TongDaXuLy

Int64

Tổng shồ sơ đã x lý trong k.

Bắt buộc

8

DaXuLyDungHen

Int64

Tổng số hồ sơ đã xử lý đúng hẹn

Bắt buộc

9

PhanTramDaXuLyDungHen

Decimal

Phần trăm hồ sơ đã xử lý đúng hẹn.

Bắt buộc

10

DaXuLyTreHen

Int64

Số hồ sơ đã xử lý trhẹn.

Bắt buộc

11

PhanTramDaXuLyTreHen

Decimal

Phần trăm hồ sơ đã xử lý trhẹn.

Bt buộc

12

TongChuaXuLy

Int64

Tng shồ sơ chưa xử lý trong kỳ.

Bắt buộc

13

ChuaXuLyTrongHan

Int64

Tng số hồ sơ chưa xlý trong hạn.

Bt buộc

14

PhanTramChuaXuLyTrongHan

Decimal

Phần trăm hồ sơ chưa xử lý trong hạn.

Bắt buộc

15

ChuaXuLyQuaHan

Int64

Shồ sơ chưa xlý quá hạn.

Bắt buộc

16

PhanTramChuaXuLyQuaHan

Decimal

Phn trăm hồ sơ chưa xử lý quá hạn.

Bắt buộc

17

GhiChu

String

Ghi chú.

Không bắt buộc

18

MaDonViC1

String

- Mã cấp 1 của cơ quan, tổ chức là đầu mối (Bộ, tnh...) kết nối với Cổng DVCQG

- Đối với các Bộ, tnh: sdụng mã cấp 1 theo QCVN 102:2016/BTTTT

Bt buộc

19

TenDonViC1

String

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

Bt buộc

20

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

21

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

22

MaDonViC3

String

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

Bắt buộc

23

TenDonViC3

String

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

Bắt buộc

24

Version

String

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

Bắt buộc

Ví dụ:

{

"Thang": 1,

"Nam":2019,

"IsThang":true,

"NhanTrongKy":10,

"TonKyTruoc":5,

"TongXuLy":11,

"TongDaXuLy":6,

"DaXuLyDungHen":3,

"PhanTramDaXuLyDungHen":50,

"DaXuLyTreHen": 0,

"PhanTramDaXuLyTreHen": 0.0,

"ChuaXuLy": 0,

"PhanTramChuaXuLy": 0.0,

"ChuaXuLyQuaHan": 0,

"PhanTramChuaXuLyQuaHan": 0.0,

TongChuaXuLy": 0,

"GhiChu": "",

"MaDonViC1":"03.99.H29",

"TenDonViC1": "",

"MaDonViC2": "",

"TenDonViC2": "",

"MaDonViC3": "",

"TenDonViC3": "",

"Version": "v2.0"

}

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

  • DacTaLienThong_APIDongBoThongKeTongHop_v1.1.docx