基本信息
接口地址
https://api.qixin.com/APIService/checkup/getCheckupListByName数据格式
JSON
请求方式
GET
请求示例
https://api.qixin.com/APIService/checkup/getCheckupListByName?name=福建宇桐机械有限公司描述
企业抽查检查信息,包括检查编号以及实施机关等
请求参数 (Headers)
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
Auth-Version |
String | 是 | 2.0(参数值),固定传入:2.0 |
appkey |
String | 是 | 启信慧眼数据开放平台获取 ,获取方式:个人中心-安全中心-API 密钥,获取appkey的同时,请完成IP白名单的配置:个人中心-安全中心-API IP白名单设置,如未配置,接口调试会报错“104 未添加IP白名单” |
timestamp |
String | 是 | UNIX时间戳,精确到毫秒,示例:1656921036000,当前系统时间近10分钟有效 |
sign |
String | 是 | 请求认证签名,对appkey+timestamp+secret_key进行md5或者sha256摘要计算的结果,小写字符串(实际加密不带入‘+’) |
请求参数 (Query)
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
name |
String | 是 | 企业全名/注册号/统一社会信用代码 |
skip |
Number | 否 | 跳过条目数(跳过的条数,默认不填返回前20条,取21到40条的数据,skip=20,以此类推进行取数) |
响应参数
| 参数名 | 类型 | 长度 | 描述 |
|---|---|---|---|
datadata.data |
Object | 0 | 返回查询结果,如果没有匹配记录则返回为空。具体字段含义见下表 |
totaldata.data.total |
Number | 0 | 返回列表中记录总数 |
numdata.data.num |
Number | 0 | 本次调用返回记录数 |
itemsdata.data.items |
Array | 0 | 抽查检查列表 |
datedata.data.items.date |
String | 50 | 日期 |
iddata.data.items.id |
String | 36 | 检查抽查编号 |
disableddata.data.items.disabled |
String | 11 | 是否历史 |
resultdata.data.items.result |
String | 2000 | 结果 |
result_typedata.data.items.result_type |
String | 255 | 结果类型,1:通过 0:不通过 -1:未知 |
departmentdata.data.items.department |
String | 1000 | 检查实施机关 |
typedata.data.items.type |
String | 50 | 类型 |
signdata.sign |
String | 32 | 数据签名 |
statusdata.status |
String | 10 | 返回结果状态 |
messagedata.message |
String | 255 | 返回结果消息 |
响应示例
JSON
{
"status": "200",
"message": "操作成功",
"sign": "439d3faf27cd11af59f782d56a637dd9",
"data": {
"total": 2,
"num": 2,
"items": [
{
"id": "5be7caef39e83d4cd0fc563f",
"department": "漳州市质监局",
"type": "抽查",
"date": "2018-10-09",
"result": "正常",
"disabled": "0"
},
{
"id": "5d1cad3f79112ed56a01f058",
"department": "福建省南靖县市场监管局",
"type": "检查",
"date": "2017-09-06",
"result": "正常",
"disabled": "0"
}
]
}
}
代码示例
javascript
let request = require('request');
let urlEncode = require('urlencode');
let crypto = require('crypto');
let baseUrl = 'https://api.qixin.com/APIService/checkup/getCheckupListByName';
let appkey = '正式appkey';
let secretKey = '正式secret_key';
let timeStamp = new Date().getTime();
const hash = crypto.createHash('md5');
let sign = hash.update(appkey + timeStamp + secretKey).digest('hex');
let urlParams = {
name: 'name的值',
skip: 'skip的值'
}
let concatParams = []
for (let key in urlParams) {
concatParams.push(key + '=' + urlParams[key]);
}
let options = {
'method': 'GET',
'url': baseUrl + '?' + concatParams.join('&'),
'headers': {
'Connection': 'keep-alive',
'Auth-version': '2.0',
'appkey': appkey,
'timestamp': timeStamp,
'sign': sign
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
文档下载
38.2-抽查检查.pdf
PDF接口文档