欢迎使用亥牟数据开放平台
首页>开发文档

新手接入指南

本指南面向首次使用亥牟数据开放平台的开发者,从注册账号到完成第一次接口调用,全程约 10 分钟。所有接口均采用标准 HTTP 协议,返回 JSON 数据,无需额外依赖即可接入任意编程语言。

五步完成接入

  1. 注册账号:访问注册页,使用手机号获取验证码完成注册,注册即赠 500 次免费调用额度。
  2. 实名认证:进入控制台「账号中心 - 实名认证」,个人用户上传身份证信息,企业用户上传营业执照,认证通过后方可正式调用付费接口。
  3. 创建应用:在「应用管理」中点击「创建应用」,填写应用名称与用途,系统将为该应用生成一对 apikey 与 secret。
  4. 获取密钥:复制应用详情中的 apikey,它是调用接口的唯一身份凭证,请妥善保管,切勿泄露或提交到公开代码仓库。
  5. 首次调用:将 apikey 拼接到接口请求地址中发起请求,即可获得返回数据。下方提供 curl 示例。
提示:免费额度仅供接口联调测试使用,正式上线前请在「价格与计费」页面选购合适的次数包,避免额度耗尽导致业务中断。

注册与实名认证

注册时请使用真实手机号,该手机号将用于登录、找回密码及接收余额预警通知。实名认证是使用付费接口的前置条件,认证信息仅用于身份核验,平台严格遵守《隐私政策》对个人信息进行保护,不会用于其他用途。

创建应用与获取 apikey

建议为不同业务场景分别创建应用,便于独立统计调用量与控制权限。每个应用的 apikey 相互独立,若某个 apikey 疑似泄露,可在应用详情中一键重置,重置后旧密钥立即失效。

首次调用示例

以「天气预报 API」为例,将下方命令中的 YOUR_APIKEY 替换为您自己的 apikey,在终端执行即可看到返回结果:

bash · curl
# 查询杭州实时天气
curl -X GET "https://hmkj4399.com/v1/weather?apikey=YOUR_APIKEY&city=杭州&type=base"

# 返回示例
# { "code": 200, "msg": "success",
#   "data": { "city": "杭州", "temp": "26", "weather": "晴" } }

若返回 "code": 200,说明调用成功。如返回其他状态码,请对照下方错误码表排查。

错误码对照表

接口通过 code 字段返回业务状态,以下为完整状态码对照,请在代码中根据 code 做相应处理。

状态码返回信息说明与处理建议
200success请求成功,正常解析 data 字段即可。
10001apikey missing请求缺少 apikey 参数,请检查请求地址是否携带密钥。
10002apikey invalidapikey 无效或已被重置,请到应用管理核对最新密钥。
10003sign error签名校验失败,请检查签名算法与参数排序是否正确。
10004param error请求参数缺失或格式错误,请对照接口文档补全必填参数。
10005quota exhausted调用次数已用尽,请前往购买次数包续费后再调用。
10006rate limit exceeded调用频率超过并发上限,请降低 QPS 或升级套餐。
10007no permission当前应用无权访问该接口,请确认套餐是否包含该接口。
10008not realname账号未完成实名认证,请先完成认证后再调用付费接口。
50000server error服务端异常,请稍后重试,若持续出现请联系客服。

SDK 下载

为方便快速集成,我们提供多语言 SDK,已封装签名、请求与返回解析逻辑。请前往帮助中心或工单获取最新版本 SDK 包与集成文档。

  • Java SDK:适用于 JDK 8 及以上,支持 Maven / Gradle 依赖引入。
  • Python SDK:适用于 Python 3.7+,pip 一键安装。
  • PHP SDK:适用于 PHP 7.2+,兼容 Composer。
  • Node.js SDK:适用于 Node 14+,支持 CommonJS 与 ESM。
  • Go SDK:适用于 Go 1.18+,Go Modules 引入。
若在接入过程中遇到问题,可通过在线客服或发送邮件至 tersoform01@gmail.com 获取技术支持,企业客户可联系专属客户经理协助接入。
在线客服 QQ 咨询 顶部