政務信息資源,數(shù)據(jù)服務接口注冊信息表范文、描述信息填寫示例、使用申請信息表范文
發(fā)布時間:2020-10-17 來源: 調(diào)查報告 點擊： 
附 錄 A （資料性）
服務接口注冊信息表模板 服務接口注冊信息表模板見表A.1。
表A.1 服務接口注冊信息表 序號 名稱 描述 1 服務名稱 數(shù)據(jù)服務接口的中文名稱，確保唯一性 2 服務摘要 提供服務的簡單描述 3 服務提供方代碼 數(shù)據(jù)服務接口的服務提供方代碼（統(tǒng)一社會信用代碼）
4 服務提供方名稱 數(shù)據(jù)服務接口的服務提供方名稱 5 所屬資源目錄 數(shù)據(jù)服務接口所屬的資源目錄，資源目錄由服務提供方編目并注冊，當服務接口注冊時，選擇相應的資源目錄 6 服務地址 服務接口的 IP 地址 7 協(xié)議類型 基于 HTTP 協(xié)議的類型，如 RPC、RESTFUL、SOAP WEBSERVICE 8 請求方法 數(shù)據(jù)服務接口的請求方法，如 POST 9 響應格式 數(shù)據(jù)服務接口的響應方法，如 JSON 10 調(diào)用頻率 服務接口的每天調(diào)用頻次之和的上限值，（如：1000 次/天）
11 服務有效日期 服務接口調(diào)用的有效截止日期，日期格式（YYYY-MM-DD）
12 參數(shù)表 參數(shù)表 13 參數(shù)名 參數(shù)名 14 參數(shù)位置 參數(shù)位置（1：header；2：body）
15 參數(shù)類型 參數(shù)類型包括但不限于 string、int、long、array、boolean、object 16 約束條件 參數(shù)約束限制條件，如字符長度等 17 描述信息 參數(shù)的描述信息 18 服務接口說明文檔 詳細的服務接口使用說明文檔，內(nèi)容應包括但不限于服務接口概述、服務接口訪問限制、服務接口參數(shù)說明、服務接口授權說明、服務接口調(diào)用示例 注：避免在服務接口使用說明文檔中暴露原始服務接口地址。
A
B
附 錄 B （資料性）
服務接口描述信息填寫示例 B.1 服務接口返回JSON格式示例 用戶信息查詢接口描述信息填寫示例見表B.1。
表B.1 用戶信息查詢接口描述信息填寫示例 接口概述 通過姓名、身份證件號碼，在人口信息資源庫中定位人員信息，并將該人員的性別、民族、出生日期和出生地信息進行反饋 接口名稱 省公安廳山東省戶籍人口信息查詢接口 接口分類 查詢類 接口方式 REST 接口地址 http://XX.XXX.XXX.XXX:XXX/gateway/1/sgatxxcx
接口授權 服務提供方授權 接口方法 GET 輸入（業(yè)務請求參數(shù)說明）
參數(shù)名 參數(shù)說明 類型 約束 姓名 在戶籍管理部門正式登記注冊，人事檔案中正式記載的姓氏名稱。
字符型
必填
身份證件號碼 身份證件上記載的、可唯一標識個人身份的號碼。
字符型
必填 輸出（業(yè)務返回參數(shù)）
參數(shù)名 參數(shù)說明 類型 備注 姓名 在戶籍管理部門正式登記注冊，人事檔案中正式記載的姓氏名稱。
字符型 非空項 身份證件號碼 身份證件上記載的、可唯一標識個人身份的號碼。
字符型 非空項 性別 性別的標識代碼按 GB/T 2261.1—2003 的規(guī)定取值。
字符型 非空項 民族 民族的標識代碼按 GB/T 3304—1991 的規(guī)定取值。
字符型 非空項 出生日期 出生證簽署的，并在戶籍部門正式登記注冊，人事檔案中記載的日期。
字符型 非空項 出生地 出生地，國家-省-市-縣-詳細地址。
字符型 非空項 返回數(shù)據(jù)格式 JSON 接口返回模板如下：
{
status:’’ data:{}||[]
msg:’’ }
B.2 服務接口返回XML格式示例 用戶信息查詢接口描述信息填寫示例見表B.2。
表B.2 用戶信息查詢接口描述信息填寫示例 接口概述 通過姓名、身份證件號碼，在人口信息資源庫中定位人員信息，并將該人員的性別、民族、出生日期和出生地信息進行反饋 接口名稱 省公安廳山東省戶籍人口信息查詢接口 接口分類 查詢類 接口方式 WebService 接口地址 http://XX.XXX.XXX.XXX:XXX/gateway/api/1/gjrkk_jzxxcx
接口授權 服務提供方授權 接口方法 cxreceiveRequest 輸入（業(yè)務請求參數(shù)說明）
參數(shù)名 參數(shù)說明 類型 約束 姓名 在戶籍管理部門正式登記注冊，人事檔案中正式記載的姓氏名稱。
字符型
必填 身份證件號碼 身份證件上記載的、可唯一標識個人身份的號碼。
字符型
必填
輸出（業(yè)務返回參數(shù)）
參數(shù)名 參數(shù)說明 類型 備注 姓名 在戶籍管理部門正式登記注冊，人事檔案中正式記載的姓氏名稱。
字符型 非空項 身份證件號碼 身份證件上記載的、可唯一標識個人身份的號碼。
字符型 非空項 性別 性別的標識代碼按 GB/T 2261.1 — 2003 的規(guī)定取值。
字符型 非空項 民族 民族的標識代碼按 GB/T 3304 — 1991 的規(guī)定取值。
字符型 非空項 出生日期 出生證簽署的，并在戶籍部門正式登記注冊，人事檔案中記載的日期。
字符型 非空項 出生地 出生地，國家-省-市-縣-詳細地址。
字符型 非空項 返回數(shù)據(jù)格式 XML 接口返回模板如下：
<?xml version="1.0" encoding="UTF-8"?> <root></root> <message></message> <code></code> <data></data> <list></list>
B
C
附 錄 C （資料性）
服務使用申請信息表模板 服務使用申請信息表模板見表C.1。
表C.1 服務使用申請信息表 序號 名稱 描述 1 服務名稱 服務使用方申請使用的服務名稱 2 服務使用方代碼 服務使用方的統(tǒng)一社會信用代碼 3 服務使用方名稱 服務使用方的名稱 4 服務使用方聯(lián)系人 服務使用方的聯(lián)系人 5 服務使用方聯(lián)系人電話 服務使用方的聯(lián)系人電話 6 服務使用方聯(lián)系人郵箱 服務使用方的聯(lián)系人電子郵箱 7 服務應用系統(tǒng)名稱 使用該服務接口的業(yè)務系統(tǒng)名稱 8 涉及的辦理事項名稱 使用該服務用于辦理的業(yè)務事項名稱 9 申請依據(jù) 描述服務使用方辦理所涉及事項時使用該服務的具體依據(jù)，如相關法律、法規(guī)、政策等 10 業(yè)務場景 服務使用方應用該服務的具體業(yè)務場景 11 服務使用期限 服務期限以天為單位，如 980 天；特殊情況下須詳細說明每年服務使用具體日期，如 1 月 1 日-5 月 1 日等 12 服務使用時間范圍 服務使用的具體時間范圍，比如 1：工作日（8:00-18:00）或 2：全天（含非工作日）
13 附件 附件包括但不限于加蓋服務使用方印章的申請表掃描件等
熱點文章閱讀