接入指南

通信协议

CSQAQ数据开放API基于HTTPS协议，需自行封装请求进行调用

所有请求及返回结果均遵循JSON格式，并使用 UTF-8 的字符集进行编码。

调用地址

环境	API地址	状态	服务地域
正式环境	https://api.csqaq.com/api/v1	可用 ✔	国内外

调用流程概述

CSQAQ数据开放API使用基于令牌+IP绑定的身份验证

API TOKEN在注册账号时默认生成，注册完成后即可直接使用。

通过 HTTP Headers 设置 ApiToken 的值为"YOUR_API_TOKEN"来进行验证

💡

调用步骤

注册成为CSQAQ网站用户

点击用户头像，获取ApiToken，复制结果

点击自动获取 或 手动绑定白名单IP 或请求绑定IP白名单接口

封装API请求 > 发起请求 > 得到响应

调用流程图示

1、获取ApiToken示例

2、令牌结果 / IP绑定

3、Postman请求参考

频率限制

注意

为不影响网站业务的正常使用，公开数据API接口请求频率和次数如下：

请求次数：不限次

单IP请求频率：1 次/秒

如果你是企业客户，有更高频率的数据合作需求，请在下方联系站长

点击添加好友

特别注意事项

请不要使用网站内【调试】功能进行调试

使用桌面版Apifox、Postman、本地代码进行调试.

原因：网页版会通过Apifox后台请求，IP不是本地的，无法匹配你的白名单IP

网站自带调试功能，请勿使用❌

公共返回报文

在所有请求的返回值里，大部分接口会有以下公共的字段：

参数名称	参数类型	说明
code	Integer	接口状态返回码
msg	String	业务状态信息
data	Object	业务数据

本站常见状态码

2xx：响应成功
400：用户不存在或Token验证未通过
401：Token验证未通过
404：接口错误统一返回
429：客户端短时间内请求过多
500：服务错误统一返回（回传request_id可协助排查）
503：网关异常或请求频繁

通信协议#

调用地址#

调用流程概述#

调用流程图示#

频率限制#

特别注意事项#