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

I. TỔNG QUAN

1.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ố.
  • API đồng bộ thông tin khai trình lao độnghỗ trợ phần mềm ISO tại đơn vị kết nối vào Nền tảng HCM LGSP đồng bộ thông tin khai trình lao động tại đơn vị về CSDL dùng chung của Thành phố.

1.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 khai trình lao động về CSDL dùng chung của Thành phố.

1.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 khai trình lao động về CSDL dùng chung của Thành phố.

II. MÔ HÌNH KẾT NỐI

 2.1. Mô hình kết nối

Hình 1: Mô hình kết nối

  • 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ố.
  • API đồng bộ thông tin khai trình lao động 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ộ thông tin khai trình lao động tại đơn vị về CSDL dùng chung của Thành phố.

2.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

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

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ụ chính thức

https://hcmlgsp.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-test.tphcm.gov.vn

 

AccessKey

Khóa

rTkhYCBwHM

SecretKey

Khóa bí mật

DWkQgY1YSS

AppName

Đơn vị kết nối

TPHCM

PartnerCode

Mã đơn vị cung cấp ứng dụng

000.00.01.H29

PartnerCodeCus

Mã đơn vị sử dụng dịch vụ

000.00.01.H29

Authorization

Khai báo trong Header, Là chuỗi gồm 5 tham số dạng json được mã hóa thành StringBase64

ewoiQWNjZXNzS2V5IjoiclRraFlDQndITSIsCiJTZWNyZ

XRLZXkiOiJEV2tRZ1kxWVNTIiwKIkFwcE5hbWUiOi

AiVFBIQ00iLAoiUGFydG5lckNvZGUiOiAiMDAwLjAw

LjAxLkgyOSIsCiJQYXJ0bmVyQ29kZUN1cyI6ICIwMD

AuMDAuMDEuSDI5Igp9Cg==

được stringbase64 từ:

{

"AccessKey":"rTkhYCBwHM",

"SecretKey":"DWkQgY1YSS",

"AppName": "TPHCM",

"PartnerCode": "000.00.01.H29",

"PartnerCodeCus": "000.00.01.H29"

}

Bảng 1: bảng thông tin kết nối

  •  

3.2. API đồng bộ thông tin khai trình lao động

  • Đường dẫn: / DongBoKhaiTrinhLaoDong
  • 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ả

Yêu cầu

1

SoGiayCNDKKD

String

Độ dài tối đa: 255

Số giấy chứng nhận đăng ký kinh doanh của doanh nghiệp đi khai trình

Bắt buộc

2

NgayDangKyNoiQuy

String

Độ dài tối đa: 50

Ngày doanh nghiệp đăng ký nội quy lao động
(dd/MM/yyyy HH:mm:ss)

 

Không bắt buộc

3

TongSoLaoDong

Number

Tổng số lao động doanh nghiệp

Không bắt buộc

4

TongSoLaoDongNu

Number

Tổng số lao động nữ

Không bắt buộc

5

CoTrinhDo

Number

Tổng lao động có trình độ

Không bắt buộc

6

NuCoTrinhDo

Number

Tổng lao động nữ có trình độ

Không bắt buộc

7

LaoDongKyMoi

Number

Tổng lao động ký mới

Không bắt buộc

8

LaoDongNuKyMoi

Number

Tổng lao động nữ ký mới

Không bắt buộc

9

LaoDongGiaHan

Number

Số lao động gia hạn

Không bắt buộc

10

LaoDongNuGiaHan

Number

Số lao động nữ gia hạn

Không bắt buộc

11

NgayDKKhaiTrinh

String

Ngày doanh nghiệp thực hiện khai trình
(dd/MM/yyyy HH:mm:ss)

Bắt buộc

12

HoKhauThanhPho

Number

Lao động hộ khẩu thành phố

Không bắt buộc

13

NuHoKhauThanhPho

Number

Lao động nữ hộ khẩu thành phố

Không bắt buộc

14

HoKhauTinh

Number

Lao động hộ khẩu tỉnh

Không bắt buộc

15

NuHoKhauTinh

Number

Lao động nữ hộ khẩu tỉnh

Không bắt buộc

16

HoKhauQuan

Number

Lao động hộ khẩu quận

Không bắt buộc

17

NuHoKhauQuan

Number

Lao động nữ hộ khẩu quận

Không bắt buộc

18

HopDongKhongXacDinh

Number

Số lượng HĐ không xác định thời gian

Không bắt buộc

19

HopDong12Den36

Number

Số lượng HĐ từ 12 đến 36 tháng

Không bắt buộc

20

HopDongDuoi12

Number

Số lượng HĐ dưới 12 tháng

Không bắt buộc

21

Version

Kiểu 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ụ:

{

  "SoGiayCNDKKD": null,

  "NgayDangKyNoiQuy": null,

  "TongSoLaoDong": 0,

  "TongSoLaoDongNu": 0,

  "CoTrinhDo": 0,

  "NuCoTrinhDo": 0,

  "LaoDongKyMoi": 0,

  "LaoDongNuKyMoi": 0,

  "LaoDongGiaHan": 0,

  "LaoDongNuGiaHan": 0,

  "NgayDKKhaiTrinh": null,

  "HoKhauThanhPho": 0,

  "NuHoKhauThanhPho": 0,

  "HoKhauTinh": 0,

  "NuHoKhauTinh": 0,

  "HoKhauQuan": 0,

  "NuHoKhauQuan": 0,

  "HopDongKhongXacDinh": 0,

  "HopDong12Den36": 0,

  "HopDongDuoi12": 0,

  "Version": null

}

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

}         

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

  • DacTaLienThong_APIDongBoKhaiTrinhLaoDong_v1.1.docx