快速开始
注册账号后登录控制台，找到需要的数据接口进入详情页开通（支持余额付费或免费试用），然后在「我的账户」获取凭据即可调用。整个接入流程仅需 4 步，无需任何签名计算。
凭据与调用
访问 Key（推荐）：在「我的账户 - 访问密钥」新增一个 Key，调用时把 Key 放在 URL 的 key 参数或请求头 X-Key 即可：
GET /api/data/接口编码?业务参数&key=你的Key
POST /api/data/接口编码?key=你的Key
Body: { "参数": "值" }AppKey 方式：请求头携带 X-AppKey 与 X-AppSecret 两个字段即可完成认证。
成功响应示例：{ "code": 0, "data": {...} }，业务结果以返回体中的 code 字段判断（0 为成功）。
鉴权方式
平台调用无需签名与时间戳，支持三种身份认证，任选其一即可：
| 方式 | 凭据 | 如何携带 | 适用场景 |
|---|---|---|---|
| 访问 Key（推荐） | 系统自动生成 | URL 参数 key（GET/POST 均可），或请求头 X-Key | 网页、小程序、脚本、服务端等轻量接入 |
| AppKey | AppKey + AppSecret | 请求头 X-AppKey + X-AppSecret | 服务端、后端程序调用 |
| JWT（登录态） | 网页登录 Token | Authorization: Bearer token | 接口详情页在线调试 |
安全提示：AppSecret 与访问 Key 都是机密凭据，请保存在服务端，切勿暴露在前端代码或日志中。
调用示例
数据接口支持 GET 与 POST 两种请求方式（以接口详情页标注为准）。GET：参数拼接到 URL query（仅扁平参数）；POST：参数以 JSON 放在请求体。以下以访问 Key 为例：
// JavaScript
const key = '你的访问Key'
const res = await fetch('/api/data/接口编码?参数=值&key=' + key)
console.log(await res.json())
// Python
import requests
resp = requests.get('/api/data/接口编码', params={ '参数': '值', 'key': key })
print(resp.json())
// AppKey 方式：请求头携带 X-AppKey / X-AppSecret，URL 无需 key
curl -X POST /api/data/接口编码 -H "X-AppKey: 你的AppKey" -H "X-AppSecret: 你的AppSecret" -d '{"参数":"值"}'
错误码表
| code | 含义 | 处理建议 |
|---|---|---|
| 0 | 调用成功 | 业务数据在 data 字段 |
| 401 | 认证失败 | 检查访问 Key 是否有效、AppKey / AppSecret 是否正确 |
| 404 | 接口不存在或已下线 | 确认接口编码拼写 |
| 405 | 请求方式不支持 | 该接口未开启当前使用的 GET/POST 方式 |
| 500 | 服务器异常 | 系统内部错误，请稍后重试 |
| 5001 | 余额不足 | 请先充值后重试 |
| 5003 | 接口未开通或次数已用完 | 在「我的接口」开通或续费 |
HTTP 状态码统一为 200，业务结果以返回体中的 code 字段判断。计费类型：free=免费试用 · count=按次 · monthly=包月。
配额与限制
- 免费试用：部分接口开放免费试用，登录后在接口详情页领取，无需付费，试用次数用完后按正常计费。
- 按次计费：每次调用从账户余额扣减对应金额，实时生效，调用失败不扣费。
- 包月计费：在有效期内按月计费，每月调用次数以接口详情页标注为准（不限次数或每月限次）。
- 余额保护：余额为 0 时返回 5001，不会产生欠费调用。
- 凭据安全：请勿将 AppSecret 与访问 Key 暴露在客户端代码中，泄露时请在「我的账户」重置。
NMS 消息服务
NMS 是平台提供的实时消息推送服务，支持 WebSocket、TCP Socket、MQTT 三种协议接入。创建消息服务后获得独立的 AppKey / AppSecret，服务之间完全隔离。
| 协议 | 连接方式 | 认证 |
|---|---|---|
| WebSocket | ws://host/nms/ws/{appKey} | URL 参数 secret |
| TCP Socket | host:9500（换行分隔 JSON 帧） | 首帧 auth |
| MQTT | host:1883（MQTT 3.1.1，QoS 0/1） | username=AppKey, password=AppSecret |
WebSocket 连接后先认证，再通过 sub / pub 订阅与发布主题；建议 30 秒心跳一次。并发连接数受套餐限制（免费 10 / 标准 100 / 专业 1000）。
// WebSocket 示例
const ws = new WebSocket('ws://host/nms/ws/你的AppKey?secret=你的AppSecret')
ws.onopen = () => ws.send(JSON.stringify({ action: 'sub', topic: 'orders' }))
ws.onmessage = (e) => console.log(JSON.parse(e.data))