企查查开放平台 API 申请及使用

2,257 阅读4分钟

简介

企查查开放平台API提供广泛的企业信息查询服务,包括公司背景、历史数据及其他相关信息。无论你是开发者、数据分析师或其他用户,都能轻松获取所需数据。 点击这里访问官网

获取API密钥

在开始使用企查查的API之前,首先需要在企查查开放平台注册并获取API密钥。

  1. 登录企查查开放平台
  2. 导航到“个人中心”并点击“我的接口”。
  3. 选择“显示所有key”以获取API的KeySecretKey

WX20231016-100914.png

接口调用

开放平台提供了丰富的API供用户选择。无论查询基础数据还是深入高级信息,均可找到合适的API。如需更多调用信息,请查阅该详情页。

截屏2023-10-16 14.09.58.png

请求地址

  • 大多数的企查查API接口都使用GET方式进行请求。
  • 每个API都有对应的请求地址,例如,企业高级搜索API的地址为 "FuzzySearch/GetList" https://api.qichacha.com/FuzzySearch/GetList?key=AppKey&searchKey=XXXXXX

参数说明

  • Token:验证加密值(通过 Md5(key+Timespan+SecretKey) 加密得到的32位大写字符串)
  • Timespan:精确到秒的Unix时间戳

示例调用

下面是一个查询企业信息的调用示例:

const axios = require('axios');
const crypto = require('crypto');

// 定义 API 信息
const apiURL = 'https://api.qichacha.com/FuzzySearch/GetList';
const appKey = 'xxxxx';  // 请替换为你的 AppKey
const secretKey = 'xxxxx';  // 请替换为你的 SecretKey
const searchKey = '北京小桔科技有限公司';  // 请替换为你要搜索的关键字

// 获取当前的 Unix 时间戳(精确到秒)
const timespan = Math.floor(Date.now() / 1000).toString();

// 计算 Token 的值:Md5(key+Timespan+SecretKey) 加密的32位大写字符串
const token = crypto.createHash('md5').update(appKey + timespan + secretKey).digest('hex').toUpperCase();

// 使用 axios 发起 API 请求
axios.get(apiURL, {
    params: {
        key: appKey,
        searchKey: searchKey
    },
    headers: {
        Token: token,
        Timespan: timespan
    }
})
.then((response) => {
    // 在这里处理 API 响应的数据
    console.log(response.data);
})
.catch((error) => {
    // 在这里处理请求错误
    console.error('There has been a problem with your fetch operation:', error);
});

响应解析

返回的数据为JSON格式。你可以使用Java、C#、Python、JavaScript等编程语言进行解析。

{
    "Paging": {
        "PageSize": 1,
        "PageIndex": 1,
        "TotalRecords": 88
    },
    "Result": [
        {
            "KeyNo": "xxxxxxxxxxx",
            "Name": "xxxxxxx",
            "CreditCode": "xxxxxxxxxxx",
            "StartDate": "2012-07-10",
            "OperName": "xx",
            "Status": "存续",
            "No": "xxxxxxxxxxxxx",
            "Address": "xxxxxxxxxxxxxx室"
        }
    ],
    "Status": "200",
    "Message": "查询成功",
    "OrderNumber": "FUZZYSEARCH2021012016353715836099"
}

错误处理

当API调用出现问题时,它会返回一个错误码。根据这个错误码,您可以判断出问题的所在。 例如,错误码“201”表示查询无结果。 参考链接

状态码描述
200【有效请求】查询成功
201【有效请求】查询无结果
202【有效请求】查询参数错误,请检查
205【有效请求】等待处理中
101【无效请求】当前的KEY无效或者还未生效中
102【无效请求】当前KEY已欠费
224【无效请求】查询参数无效
......

费用说明

  • 计次:每个接口都有相应的调用费用,根据调用次数计费;
  • 余额:无需额外购买次数,往您的账户余额上充值进行接口调用(需先申请接口,支持所有接口调用);
  • 企业户: 按企业清单计费,每个清单最小计量单位为户,适用于存在固定企业清单的客户进行场景化的业务对接。

安全建议

  • 请不要在公共场合展示您的API Key和SecretKey。
  • 定期更换API密钥,以确保其安全。
  • 请不要在客户端代码中硬编码API密钥,以防密钥泄露。
  • 在进行大量查询时,请确保您的网络环境安全,防止被恶意截取。

注意事项

在使用API时,请确保您已阅读并理解企查查开放平台的使用条款和数据使用政策。适度使用API,避免不必要的频繁请求,以便于平台能够更好地服务于所有用户。

以上就是关于企查查开放平台API的基础使用教程。希望对您有所帮助!如果有其他疑问或需求,请随时查阅企查查的官方文档或与客服团队联系。