Toanph 21/05/2020

CSDL Đăng ký doanh nghiệp#

I. Nghiệp vụ#

Hiện tại đã có thể kết nối với CSDL Đăng ký doanh nghiệp với một số nghiệp vụ sau:

Stt	Tên API	Mô tả nghiệp vụ
1	API Lấy thông tin chi tiết của một doanh nghiệp	Tra cứu thông tin của một doanh nghiệp dựa vào mã doanh nghiệp
2	API lấy danh sách các hồ sơ xử lý trong ngày	Đồng bộ hồ sơ xử lý trong ngày từ phần mềm trên Bộ KHĐT về phần mềm một cửa Sở KHĐT
3	API cung cấp danh sách các hồ sơ tiếp nhận trong khoảng thời gian	Đồng bộ hồ sơ xử lý trong một khoảng thời gian từ phần mềm trên Bộ KHĐT về phần mềm một cửa Sở KHĐT
4	API cung cấp thông tin chi tiết tiếp nhận của 01 hồ sơ đăng ký doanh nghiệp	Tra cứu thông tin, trạng thái của một hồ sơ đã được đồng bộ về trên phần mềm Sở KHĐT

II. Các API#

Lấy token#

Tham khảo (xem chi tiết)

1. API Lấy thông tin chi tiết của một doanh nghiệp#

Mục đích: Có thể lấy thông tin chi tiết của doanh nghiệp dựa vào mã số doanh nghiệp

1. Request Header

URL: ***/ngsp/DangKyDoanhNghiep/LayThongTinDN
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request Params

    maDoanhNghiep: "Mã số doanh nghiệp"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Xem chi tiết tại mục 1.1 Gói tin thông tin chi tiết của một doanh nghiệp (xem chi tiết)

2. API lấy danh sách các hồ sơ xử lý trong ngày#

1. Request Header

URL: ***/ngsp/DangKyDoanhNghiep/LayHoSoTrongNgay
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request Params

    thoiGianBatDau: "Từ thời gian, định dạng (HH:mm), lưu ý HH định dạng 24 giờ", // String
    thoiGianKetThuc: "Đến thời gian, định dạng (HH:mm), lưu ý HH định dạng 24 giờ", // String
    limit: "Số bản ghi tối đa lấy về trong 1 phiên gọi dịch vụ", // String
    offset: "Số dịch chuyển bản ghi đầu tiên"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Xem chi tiết tại mục 1.2 Gói tin danh sách các hồ sơ xử lý trong ngày (xem chi tiết)

3. API cung cấp danh sách các hồ sơ tiếp nhận trong khoảng thời gian#

1. Request Header

URL: ***/ngsp/DangKyDoanhNghiep/LayDanhSachHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

    ngayBatDau: "Ngày bắt đầu, định dạng (dd/MM/yyyy), lưu ý ngày tháng phải đủ 2 chữ số, năm đủ 4 chữ số", // String
    ngayKetThuc: "Ngày kết thúc, định dạng (dd/MM/yyyy), lưu ý ngày tháng phải đủ 2 chữ số, năm đủ 4 chữ số", // String
    limit: "Số bản ghi tối đa lấy về trong 1 phiên gọi dịch vụ", // String
    offset: "Số dịch chuyển bản ghi đầu tiên"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Gói tin danh sách các hồ sơ tiếp nhận trong khoảng thời gian (xem chi tiết)

4. API cung cấp thông tin chi tiết tiếp nhận của 01 hồ sơ đăng ký doanh nghiệp#

1. Request Header

URL: ***/ngsp/DangKyDoanhNghiep/TinhTrangHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request Params

    maHoSo: "Mã hồ sơ" // String

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Gói tin thông tin chi tiết tiếp nhận của 01 hồ sơ đăng ký doanh nghiệp (xem chi tiết)

Tham khảo#

Tham khảo các API kết nối qua postman