1. TỔNG QUAN
   1. Mô tả nghiệp vụ

• Phần mềm ISO điện tử khi có nhu cầu lấy chi tiết thông tin thủ tục hành chính thì sẽ gọi api lấy chi tiết thông tin thủ tục hành chính lên HCM LGSP (APITraCuuDanhMucThuTucHanhChinhTheoMaLinhVuc).
• HCM LGSP sẽ lấy chi tiết thông tin thủ tục hành chính từ CSDL dùng chung của Thành phố và trả về chi tiết thông tin thủ tục hành chính cho đơn vị.
  2. Mục đích tài liệu
• Tài liệu này nhằm hướng dẫn đơn vị lấy chi tiết thông tin thủ tục hành chính từ CSDL tập trung 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 lấy chi tiết thông tin thủ tục hành chính từ chuẩn CSDL dùng chung của Thành phố.
  4. Thông tin kết nối
• Đơn vị cần kết nối liên hệ sở Thông tin và Truyền thông để được cung cấp thông tin kết nối bao gồm:
  • AppName
  • AccessKey
  • SecretKey

2. MÔ HÌNH KẾT NỐI
   1. Mô hình kết nối lấy chi tiết danh mục thủ tục hành chính

Hình 1: Mô hình kết nối lấy chi tiết danh mục thủ tục hành chính

• 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ố.
• APITraCuuDanhMucThuTucHanhChinhTheoMaLinhVuc hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy chi tiết thông tin Thủ tục hành chính chuẩn từ CSDL dùng chung của Thành phố..
  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ị gọi đến Nền tảng HCM LGSP thông qua api kèm theo access token.
• Bước 2: 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 3: 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ị.

3. ĐẶC TẢ API LẤY CHI TIẾT DANH MỤC THỦ TỤC HÀNH CHÍNH
   1. Thông tin kết nối

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

• 2. API cung cấp chi tiết danh mục thủ tục hành chính
• Đường dẫn: /TraCuuThuTuc_GetByMaLinhVuc
• Method: GET
• Đầu vào:
  • Header: Authorization
  • Param:
    • MaLinhVuc = 000.00.02.H29
• Đầu ra:
  • chuỗi json chứa thông tin trả về, resultObject là chuỗi json chứa thông tin danh mục, chi tiết dữ liệu tại mục 3.3

Bảng 2: tham số trả về của chuỗi json

Ví dụ:

1. 3. Gói tin danh mục thủ tục hành chính

Bảng 3: gói tin danh mục thủ tục hành chính

Ví dụ:

4. CODE EXAMPLE
   1. Code mẫu .Net

using RestSharp;

using System;

using System.Collections.Generic;

using System.Configuration;

using System.Linq;

using System.Text;

• API Method Get

public static String HTTP_GET(String url, String urlSerivce, String sercet, Dictionary<string, string> param)

        {

            var client = new RestClient(url);

            var request = new RestRequest(urlSerivce, Method.GET);

            request.AddHeader("Authorization", sercet);

            //Add Parameter vào request

            foreach (var item in param)

            {

                      request.AddParameter(item.Key, item.Value);

            }

            var response = client.Execute(request);

            if(response.StatusCode == System.Net.HttpStatusCode.OK)

            {

                       return response.Content;

            }

            else

            {

                      //Xử lý trường hợp kết nối lỗi

                      return "";

            }

        }

• API Method POST

   //jsonObj : object có cấu trúc theo như mô tả

        public static String HTTP_POST(String url, String urlSerivce, String sercet,object jsonObj)

        {

            var client = new RestClient(url);

            var request = new RestRequest(urlSerivce, Method.GET);

            request.AddHeader("Authorization", sercet);

            request.AddHeader("Content-Type", "application/json;charset=UTF-8");

            request.AddBody(jsonObj); // jsonObj sẽ được tự động chuyển thành chuỗi json tương ứng

            var response = client.Execute(request);

            if(response.StatusCode == System.Net.HttpStatusCode.OK)

            {

                return response.Content;

            }

            else

            {

                //Xử lý trường hợp kết nối lỗi

                return "";

            }

        }

• 3.DacTaLienThong_APITraCuuDanhMucThuTucHanhChinhTheoMaLinhVuc_v1.1.docx