版本升级2.0.4
This commit is contained in:
parent
c4ed5b1c3a
commit
005b91a4c7
|
|
@ -0,0 +1,324 @@
|
|||
|
||||
|
||||
|
||||
内蒙古自治区市场监督管理局信用监管综合系统
|
||||
批量吊销对接
|
||||
接口规范
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
编 制: 陈天生
|
||||
审 核:
|
||||
日 期: 2026年3月9日
|
||||
版 本: v1.1
|
||||
|
||||
|
||||
|
||||
[pic]
|
||||
|
||||
|
||||
|
||||
目 录
|
||||
1. 适用范围 1
|
||||
2. 接口概述 1
|
||||
2.1. 接口组成 1
|
||||
2.2. REST风格 1
|
||||
2.3. 错误信息结构 1
|
||||
2.4. 调用流程 2
|
||||
3. 接口API 4
|
||||
3.1. 安全会话接口 4
|
||||
3.1.1. 登录 4
|
||||
3.1.2. 退出登录 6
|
||||
3.2. 接收批量吊销信息 8
|
||||
4. 数据模型 10
|
||||
4.1. 吊销市场主体清单(penaltylist) 10
|
||||
5. 数据字典 10
|
||||
5.1. 错误码定义 10
|
||||
|
||||
|
||||
修改历史
|
||||
|
||||
|修改时间 |修改人 |修改原因 |版本 |
|
||||
|2026.1.11 |陈天生 |创建。 |1.0 |
|
||||
|2026.3.8 |黎润豪 |修正 |1.1 |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
适用范围
|
||||
|
||||
本规范适用于执法办案系统与内蒙古自治区市场监督管理局信用监管综合系统,实现
|
||||
市场主体吊销信息的对接。
|
||||
|
||||
接口概述
|
||||
|
||||
|
||||
1 接口组成
|
||||
|
||||
内蒙古自治区市场监督管理局信用监管综合系统批量吊销接口包括执法办案信息接收
|
||||
接口和安全认证授权接口。
|
||||
——执法办案信息接收接口。对外提供执法办案信息接收。
|
||||
——安全认证授权接口。提供对接入内蒙古自治区市场监督管理局信用监管综合系统的
|
||||
应用系统和用户身份进行合法性验证和授权功能。
|
||||
|
||||
2 REST风格
|
||||
|
||||
内蒙古自治区市场监督管理局信用监管综合系统批量吊销相关接口API按照REST风格
|
||||
设计,通过HTTP协议的GET方法或POST方法提交请求。
|
||||
使用GET方法,请求参数通过URL参数(QueryParam)提供。
|
||||
使用POST方法,请求公共参数通过URL参数(QueryParam)提供。
|
||||
接口专用参数通过请求正文(Body)、按照JSON格式封装提供。
|
||||
|
||||
3 错误信息结构
|
||||
|
||||
|ERRORS |
|
||||
|属性 |类型 |说明 |
|
||||
|errorCode |String |接口错误代码 |
|
||||
|message |String |业务错误信息 |
|
||||
|
||||
|
||||
请求错误返回示例:
|
||||
{
|
||||
"ackCode":"FAILURE",
|
||||
"errors": [{"name":"接口登录失败",
|
||||
"errorCode":"12002",
|
||||
"message":"app_key无效"}],
|
||||
}
|
||||
|
||||
4 调用流程
|
||||
|
||||
内蒙古自治区市场监督管理局信用监管综合系统批量吊销接口API调用流程分为三个
|
||||
步骤。
|
||||
(一)第一步:调用 login 创建安全会话获取 access_token
|
||||
调用安全会话接口的 login 方法,以提供的账号创建会话获取访问令牌
|
||||
access_token。
|
||||
请求示例:
|
||||
POST https://{API_ROOT}/security/login
|
||||
Content-Type: application/json
|
||||
{"appKey":"APP_KEY","appSecret":"APP_SECRET","account":"ACCOUNT"
|
||||
}
|
||||
返回结果:
|
||||
{"ack_code":"SUCCESS","errors":[],"access_token":"ACCESS_TOKEN"}
|
||||
(二)第二步:使用 access_token 调用接口 API
|
||||
把access_token作为请求的公共参数来调用接口 API。
|
||||
请求示例:
|
||||
POST
|
||||
https://{API_ROOT}/security/receiveCaseinfo?access_token=ACCESS_TOKEN
|
||||
Content-Type: application/json
|
||||
{
|
||||
"caseid": "案件编号",
|
||||
"casename": "案件名称",
|
||||
"caseintroduction": "案由",
|
||||
"illegality": "违法行为",
|
||||
"penalty": "处罚内容",
|
||||
"penaltydate": "处罚决定日期",
|
||||
"penaltyorg": "处罚决定机关",
|
||||
"penaltylist": [
|
||||
{
|
||||
"pripid":"市场主体身份代码",
|
||||
"uniscid":"统一社会信用代码",
|
||||
"legal":"法定代表人" ,
|
||||
"enttype":"市场主体类型"
|
||||
}
|
||||
]
|
||||
}
|
||||
返回结果:
|
||||
{
|
||||
"ackCode":"SUCCESS",
|
||||
"errors":[] ,
|
||||
"acceptid":"业务受理号"
|
||||
}
|
||||
|
||||
(三)第三步:调用 logout 注销会话
|
||||
调用安全会话接口的logout方法,设置access_token为无效。
|
||||
请求示例:
|
||||
POST https://{API_ROOT}/security/logout?access_token=ACCESS_TOKEN
|
||||
Content-Type: application/json
|
||||
|
||||
返回结果:
|
||||
{"ackCode":"SUCCESS","errors":[]}
|
||||
|
||||
接口API
|
||||
|
||||
|
||||
1 安全会话接口
|
||||
|
||||
|
||||
1 登录
|
||||
|
||||
方法名称
|
||||
login
|
||||
方法说明
|
||||
通过用户名和密码进行身份验证,验证成功后创建一个会话。所有对数据和附件的管
|
||||
理操作都必须在有效的会话内进行,因此创建会话是接口系统调用的第一个方法。
|
||||
请求方法
|
||||
POST
|
||||
URL 地址
|
||||
https://{API_ROOT}/security/login
|
||||
访问权限
|
||||
合法接入内蒙古自治区市场监督管理局信用监管综合系统批量吊销接口系统的应用程
|
||||
序。
|
||||
请求参数
|
||||
|参数名 |必选|类型范围 |说明 |
|
||||
|appKey |是 |String |分配给应用程序的 appKey |
|
||||
|appSecret |是 |String |分配给应用程序appSecret |
|
||||
|account |是 |String |用户账户名称 |
|
||||
|
||||
返回结果
|
||||
|参数名 |必选 |类型范围 |说明 |
|
||||
|access_token|是 |String |登录成功则返回安全会话访问令牌(30分|
|
||||
| | | |钟有效) |
|
||||
|
||||
请求示例
|
||||
POST https://{API_ROOT}/security/login
|
||||
Content-Type: application/json
|
||||
{
|
||||
"appKey":"APP_KEY",
|
||||
"appSecret":"APP_SECRET",
|
||||
"account":"test"
|
||||
}
|
||||
|
||||
返回示例
|
||||
{
|
||||
"ackCode":"SUCCESS",
|
||||
"errors":[],
|
||||
"accessToken":"ACCESS_TOKEN"
|
||||
}
|
||||
|
||||
|
||||
2 退出登录
|
||||
|
||||
方法名称
|
||||
logout
|
||||
方法说明
|
||||
注销当前会话。
|
||||
请求方法
|
||||
POST
|
||||
URL 地址
|
||||
https://{API_ROOT}/security/logout
|
||||
访问权限
|
||||
已登录用户。
|
||||
请求参数
|
||||
无。
|
||||
返回结果
|
||||
无。
|
||||
请求示例
|
||||
POST https://{API_ROOT}/security/logout?access_token=ACCESS_TOKEN
|
||||
Content-Type: application/json
|
||||
{
|
||||
}
|
||||
|
||||
返回示例
|
||||
{
|
||||
"ackCode":"SUCCESS",
|
||||
"errors":[]
|
||||
}
|
||||
|
||||
|
||||
2 接收批量吊销信息
|
||||
|
||||
方法名称
|
||||
receiveCaseinfo
|
||||
方法说明
|
||||
接收批量吊销信息。
|
||||
请求方法
|
||||
POST
|
||||
URL 地址
|
||||
https://{API_ROOT}/security/receiveCaseinfo
|
||||
访问权限
|
||||
已登录用户。
|
||||
请求参数
|
||||
|参数名 |必选 |类型范围|说明 |
|
||||
|caseid |是 |String |案件编号 |
|
||||
|casename |是 |String |案件名称 |
|
||||
|caseintroduction|是 |String |案由 |
|
||||
|illegality |是 |String |违法行为 |
|
||||
|penalty |是 |String |处罚内容 |
|
||||
|penaltydate |是 |String |处罚决定日期,yyyy-MM-dd |
|
||||
|penaltyorg |是 |String |处罚决定机关 |
|
||||
|penaltylist |是 |List |吊销市场主体清单 |
|
||||
|
||||
返回结果
|
||||
|参数名 |必选 |类型范围 |说明 |
|
||||
|acceptid |是 |String |业务受理号 |
|
||||
|
||||
请求示例
|
||||
POST
|
||||
https://{API_ROOT}/security/receiveCaseinfo?access_token=ACCESS_TOKEN
|
||||
Content-Type: application/json
|
||||
{
|
||||
"caseid": "案件编号",
|
||||
"casename": "案件名称",
|
||||
"caseintroduction": "案由",
|
||||
"illegality": "违法行为",
|
||||
"penalty": "处罚内容",
|
||||
"penaltydate": "处罚决定日期",
|
||||
"penaltyorg": "处罚决定机关",
|
||||
"penaltylist": [
|
||||
{
|
||||
"pripid":"市场主体身份代码",
|
||||
"uniscid":"统一社会信用代码",
|
||||
"legal":"法定代表人" ,
|
||||
"enttype":"市场主体类型"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
返回示例
|
||||
{
|
||||
"ackCode":"SUCCESS",
|
||||
"errors":[] ,
|
||||
"accpetid":"业务受理号"
|
||||
}
|
||||
}
|
||||
|
||||
数据模型
|
||||
|
||||
|
||||
1 吊销市场主体清单(penaltylist)
|
||||
|
||||
|参数名 |必选 |类型范围 |说明 |
|
||||
|pripid |是 |String |市场主体身份代码 |
|
||||
|uniscid |是 |String |统一社会信用代码 |
|
||||
|legal |是 |String |法定代表人(负责人) |
|
||||
|enttype |是 |String |市场主体类型 |
|
||||
|
||||
|
||||
数据字典
|
||||
|
||||
|
||||
1 错误码定义
|
||||
|
||||
|错误代码 |错误说明 |建议处理方式 |
|
||||
|12002 |appKey无效 |检查程序是正确提供了 appKey 参数。|
|
||||
|12003 |缺少 appSecret 参数 |检查程序是正确提供了 appSecret 参 |
|
||||
| | |数。 |
|
||||
|12004 |登录信息无效 |检查程序提供的account是否正确 |
|
||||
|13000 |ACCESS_TOKEN无效 |ACCESS_TOKEN无效。 |
|
||||
|14000 |案件编号不能为空 |案件编号不能为空 |
|
||||
|14001 |案件名称不能为空 |案件名称不能为空 |
|
||||
|14002 |案由不能为空 |案由不能为空 |
|
||||
|14003 |违法行为不能为空 |违法行为不能为空 |
|
||||
|14004 |处罚内容不能为空 |处罚内容不能为空 |
|
||||
|14005 |处罚决定日期不能为空|处罚决定日期不能为空 |
|
||||
|14006 |处罚决定机关不能为空|处罚决定机关不能为空 |
|
||||
|14007 |吊销市场主体清单不能|吊销市场主体清单不能为空 |
|
||||
| |为空 | |
|
||||
|14008 |吊销市场主体清单内容|吊销市场主体清单内容不能有空 |
|
||||
| |不能有空 | |
|
||||
|
||||
-----------------------
|
||||
|
||||
|
||||
|
||||
|
||||
1
|
||||
|
||||
|
||||
|
||||
|
||||
6
pom.xml
6
pom.xml
|
|
@ -174,17 +174,17 @@
|
|||
<dependency>
|
||||
<groupId>youfool-framework-sso</groupId>
|
||||
<artifactId>sso-core</artifactId>
|
||||
<version>2.0.3</version>
|
||||
<version>2.0.4</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>youfool-framework-sso</groupId>
|
||||
<artifactId>sso-redis-support</artifactId>
|
||||
<version>2.0.3</version>
|
||||
<version>2.0.4</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>youfool-framework-sso</groupId>
|
||||
<artifactId>sso-boot-support</artifactId>
|
||||
<version>2.0.3</version>
|
||||
<version>2.0.4</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.microsoft.sqlserver</groupId>
|
||||
|
|
|
|||
Loading…
Reference in New Issue