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ộ đăng ký kết hôn 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ộ đăng ký kết hôn 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ộ đăng ký kết hôn 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ộ đăng ký kết hôn 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 đồng bộ hồ sơ

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ộ đăng ký kết hôn 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ộ đăng ký kết hôn 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

ewoiQWNjZXNzS2V5IjoiclRraFlDQndITSIsCiJTZWNyZXRLZ

XkiOiJEV2tRZ1kxWVNTIiwKIkFwcE5hbWUiOiAiVFBIQ00iLAo

iUGFydG5lckNvZGUiOiAiMDAwLjAwLjAxLkgyOSIsCiJQY

XJ0bmVyQ

29kZUN1cyI6ICIwMDAuMDAuMDEuSDI5Igp9Cg==

đượ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ộ đăng ký kết hôn

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

MaDonVi

String

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

Mã đơn vị kết nối gửi dữ liệu

Bắt buộc

2

BenNamHoTen

String

Họ tên của người đăng ký bên nam

 

Bắt buộc

3

BenNamNgaySinh

String

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

Ngày sinh của người đăng ký bên nam
(dd/MM/yyyy HH:mm:ss)

Bắt buộc

4

BenNamDienThoai

String

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

Điện thoại của người đăng ký bên nam

Không bắt buộc

5

BenNamDanToc

String

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

Tên dân tộc của người đăng ký bên nam

Không bắt buộc

6

BenNamQuocTich

String

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

Tên quốc tịch của người đăng ký bên nam

Không bắt buộc

7

BenNamLoaiGiayChungThuc

Number

Loại giấy chứng thực bên nam
1: Giấy CMND
2: Giấy chứng thực
3: Hộ chiếu

Bắt buộc

8

BenNamSoGiayChungThuc

String

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

Số giấy chứng thực bên nam

Bắt buộc

9

BenNamDiaChiTamThuongTru

String

Địa chỉ tạm trú, thường trú bên nam

Không bắt buộc

10

BenNuHoTen

String

Họ tên của người đăng ký bên nữ

Bắt buộc

11

BenNuNgaySinh

String

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

Ngày sinh của người đăng ký bên nữ
(dd/MM/yyyy HH:mm:ss)

Bắt buộc

12

BenNuDienThoai

String

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

Điện thoại của người đăng ký bên nữ

Không bắt buộc

13

BenNuDanToc

String

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

Tên dân tộc của người đăng ký bên nữ

Không bắt buộc

14

BenNuQuocTich

String

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

Tên quốc tịch của người đăng ký bên nữ

Không bắt buộc

15

BenNuLoaiGiayChungThuc

Number

Loại giấy chứng thực bên nữ

Bắt buộc

16

BenNuSoGiayChungThuc

String

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

Số giấy chứng thực bên nữ
1: Giấy CMND
2: Giấy chứng thực
3: Hộ chiếu

Bắt buộc

17

BenNuDiaChiTamThuongTru

String

Địa chỉ tạm trú, thường trú bên nữ

Không bắt buộc

18

CanBoNhanHoSo

String

Cán bộ nhận xử lý hồ sơ

Không bắt buộc

19

TenDangNhapCBNhanHoSo

String

Tên đăng nhập hệ thống của cán bộ xử lý

Không bắt buộc

20

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ụ:

{

  "MaDonVi": null,

  "BenNamHoTen": null,

  "BenNamNgaySinh": null,

  "BenNamDienThoai": null,

  "BenNamDanToc": null,

  "BenNamQuocTich": null,

  "BenNamLoaiGiayChungThuc": 0,

  "BenNamSoGiayChungThuc": null,

  "BenNamDiaChiTamThuongTru": null,

  "BenNuHoTen": null,

  "BenNuNgaySinh": null,

  "BenNuDienThoai": null,

  "BenNuDanToc": null,

  "BenNuQuocTich": null,

  "BenNuLoaiGiayChungThuc": 0,

  "BenNuSoGiayChungThuc": null,

  "BenNuDiaChiTamThuongTru": null,

  "CanBoNhanHoSo": null,

  "TenDangNhapCBNhanHoSo": null,

  "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_APIDongBoDangKyKetHon_v1.1.docx

API đồng bộ thông tin đăng ký kết hôn

Câu hỏi thường gặp

CHÚNG TÔI LUÔN SẴN
SÀNG ĐỂ GIÚP ĐỠ BẠN

Hỗ trợ trực tuyến

Để được hỗ trợ tốt nhất. Hãy gọi

028 38233717 - 111
HOẶC
0889490111

SỞ THÔNG TIN VÀ TRUYỀN THÔNG TPHCM

LIÊN KẾT WEBSITE

KẾT NỐI VỚI CHÚNG TÔI

  • chinh-se-tren-gm
  • chinh-se-tren-fb
  • chinh-se-mes-tren-fb
  • chinh-se-tren-gg
  • chinh-se-tren-tw
Giấy phép số 91/GP-TTĐT, do Cục Phát thanh, Truyền hình và Thông tin điện tử - Bộ Thông tin và Truyền thông cấp ngày 26/04/2018