基本信息
接口地址
https://api.qixin.com/APIService/relation/createFindRelationTask数据格式
JSON
请求方式
GET
请求示例
https://api.qixin.com/APIService/relation/createFindRelationTask?enterprises=北京小桔科技有限公司,滴滴(中国)科技有限公司描述
企业间找关系(十家),支持最多十家公司间的投资任职关系。异步接口,根据此接口返回的id在“33.11企业间找关系-详细数据”获取结果数据
请求参数 (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)
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
enterprises |
String | 是 | 企业全名字符串, 注意企业名称间用英文逗号分隔。支持最少两家最多十家企业 |
persons |
String | 否 | 人员信息字符串, 注意人员间用英文逗号分隔。企业名称和人员姓名用|分隔 如:企业 A|人员 A,企业 B|人员 B和企业共支持最少两家最多十家企业 |
relations |
String | 否 | 直接关系类型,默认全部,格式如下SH|HSH|EXEC|HEXEC|LR|HLR|branch; SH股东、EXEC董监高、HEXEC历史董监高、LR法人、HSH历史股东、branch分支机构、HLR历史法人 |
level |
String | 否 | 层级,默认6层,1-7层 |
containSuspect |
String | 否 | 是否包含疑似关系 1-包含 0-不包含 |
suspect_relations |
String | 否 | 疑似关系类型,包含默认全部:same_phone|same_address|same_email|same_history_phone|same_history_address|same_history_email|same_website|same_web_email|same_proper_name|same_patent|same_software|same_lawsuit |
path |
String | 否 | 关系路径,枚举:0:最短路径;1:全部路径,该接口默认查询最短路径 |
响应参数
| 参数名 | 类型 | 长度 | 描述 |
|---|---|---|---|
datadata.data |
Object | 0 | 返回查询结果,如果没有匹配记录则返回为空。具体字段含义见下表 |
keydata.data.key |
String | 255 | 企业关系的key,用户可调用接口33.11企业间找关系-详细数据来获取job状态(24h内有效) |
paramsdata.data.params |
Array | 0 | |
uidListdata.data.params.uidList |
Object | 0 | 用户id列表 |
leveldata.data.params.level |
String | 3 | 层级 |
pair_single_tagdata.data.params.pair_single_tag |
String | 255 | 单对关系标识 |
pair_single_suspectdata.data.params.pair_single_suspect |
String | 255 | 单对疑似关系 |
filter_relationdata.data.params.filter_relation |
String | 255 | 关联关系 |
nodesOnedata.data.params.nodesOne |
Array | 0 | 节点1 |
eiddata.data.params.nodesOne.eid |
String | 36 | 企业id |
uiddata.data.params.nodesOne.uid |
String | 36 | 用户id |
namedata.data.params.nodesOne.name |
String | 255 | 企业名称 |
typedata.data.params.nodesOne.type |
String | 255 | 企业类型 |
nodesTwodata.data.params.nodesTwo |
Array | 0 | 节点2 |
eiddata.data.params.nodesTwo.eid |
String | 36 | 企业id |
uiddata.data.params.nodesTwo.uid |
String | 36 | 用户id |
namedata.data.params.nodesTwo.name |
String | 255 | 企业名称 |
typedata.data.params.nodesTwo.type |
String | 255 | 企业类型 |
nodesThreedata.data.params.nodesThree |
Array | 0 | 节点3 |
eiddata.data.params.nodesThree.eid |
String | 36 | 企业id |
uiddata.data.params.nodesThree.uid |
String | 36 | 用户id |
namedata.data.params.nodesThree.name |
String | 255 | 企业名称 |
typedata.data.params.nodesThree.type |
String | 255 | 企业类型 |
nodesFourdata.data.params.nodesFour |
Array | 0 | 节点4 |
eiddata.data.params.nodesFour.eid |
String | 36 | 企业id |
uiddata.data.params.nodesFour.uid |
String | 36 | 用户id |
namedata.data.params.nodesFour.name |
String | 255 | 企业名称 |
typedata.data.params.nodesFour.type |
String | 255 | 企业类型 |
nodesFivedata.data.params.nodesFive |
Array | 0 | 节点5 |
eiddata.data.params.nodesFive.eid |
String | 36 | 企业id |
uiddata.data.params.nodesFive.uid |
String | 36 | 用户id |
namedata.data.params.nodesFive.name |
String | 255 | 企业名称 |
typedata.data.params.nodesFive.type |
String | 255 | 企业类型 |
nodesSixdata.data.params.nodesSix |
Array | 0 | 节点6 |
eiddata.data.params.nodesSix.eid |
String | 36 | 企业id |
uiddata.data.params.nodesSix.uid |
String | 36 | 用户id |
namedata.data.params.nodesSix.name |
String | 255 | 企业名称 |
typedata.data.params.nodesSix.type |
String | 255 | 企业类型 |
nodesSevendata.data.params.nodesSeven |
Array | 0 | 节点7 |
eiddata.data.params.nodesSeven.eid |
String | 36 | 企业id |
uiddata.data.params.nodesSeven.uid |
String | 36 | 用户id |
namedata.data.params.nodesSeven.name |
String | 255 | 企业名称 |
typedata.data.params.nodesSeven.type |
String | 255 | 企业类型 |
nodesEightdata.data.params.nodesEight |
Array | 0 | 节点8 |
eiddata.data.params.nodesEight.eid |
String | 36 | 企业id |
uiddata.data.params.nodesEight.uid |
String | 36 | 用户id |
namedata.data.params.nodesEight.name |
String | 255 | 企业名称 |
typedata.data.params.nodesEight.type |
String | 255 | 企业类型 |
nodesNinedata.data.params.nodesNine |
Array | 0 | 节点9 |
eiddata.data.params.nodesNine.eid |
String | 36 | 企业id |
uiddata.data.params.nodesNine.uid |
String | 36 | 用户id |
namedata.data.params.nodesNine.name |
String | 255 | 企业名称 |
typedata.data.params.nodesNine.type |
String | 255 | 企业类型 |
nodesTendata.data.params.nodesTen |
Array | 0 | 节点10 |
eiddata.data.params.nodesTen.eid |
String | 36 | 企业id |
uiddata.data.params.nodesTen.uid |
String | 36 | 用户id |
namedata.data.params.nodesTen.name |
String | 255 | 企业名称 |
typedata.data.params.nodesTen.type |
String | 255 | 企业类型 |
filter_rels_tagdata.data.params.filter_rels_tag |
String | 255 | 关系标识 |
signdata.sign |
String | 32 | 数据签名 |
statusdata.status |
String | 10 | 返回结果状态 |
messagedata.message |
String | 255 | 返回结果消息 |
响应示例
JSON
{
"status": "200",
"message": "操作成功",
"sign": "3036ed85a61e14bfb9efdc2daea39759",
"data": {
"key": "fd_rlt_excl_res:6d39ebb0-f313-4eba-9ef4-57c0c312af5c",
"params": {
"nodesOne": [
{
"eid": "9d4097de-0163-450a-bf62-4efaa34d7761",
"uid": "9d4097de-0163-450a-bf62-4efaa34d7761",
"name": "北京小桔科技有限公司",
"type": "E"
},
{
"eid": "7015739c-4526-4fca-b8fb-cab9521a78b8",
"uid": "7015739c-4526-4fca-b8fb-cab9521a78b8",
"name": "滴滴(中国)科技有限公司",
"type": "E"
}
],
"nodesTwo": [
{
"eid": "9d4097de-0163-450a-bf62-4efaa34d7761",
"uid": "9d4097de-0163-450a-bf62-4efaa34d7761",
"name": "北京小桔科技有限公司",
"type": "E"
},
{
"eid": "7015739c-4526-4fca-b8fb-cab9521a78b8",
"uid": "7015739c-4526-4fca-b8fb-cab9521a78b8",
"name": "滴滴(中国)科技有限公司",
"type": "E"
}
],
"filter_relation": "LR|PEXEC|EXEC|HEXEC|SH|HSH|branch",
"filter_rels_tag": "true",
"pair_single_tag": "false",
"pair_single_suspect": "false",
"uidList": [
"9d4097de-0163-450a-bf62-4efaa34d7761",
"7015739c-4526-4fca-b8fb-cab9521a78b8",
"9d4097de-0163-450a-bf62-4efaa34d7761",
"7015739c-4526-4fca-b8fb-cab9521a78b8"
],
"level": 6
}
}
}
代码示例
javascript
let request = require('request');
let urlEncode = require('urlencode');
let crypto = require('crypto');
let baseUrl = 'https://api.qixin.com/APIService/relation/createFindRelationTask';
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 = {
enterprises: 'enterprises的值',
persons: 'persons的值',
relations: 'relations的值',
level: 'level的值',
containSuspect: 'containSuspect的值',
suspect_relations: 'suspect_relations的值',
path: 'path的值'
}
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);
});