自述文档 - 中文

This page is also available in English: README - English

云端点 API 对外说明。接口明细以在线文档为准。

【常用链接】

🏡 官网 / 控制台：https://www.yddm.com

🔌 API 基址：https://api.yddm.com

📚 接口文档：https://docs.yddm.com/

🎫 联系与支持：微信 wx2026-maxiao（认证/开通/对账等问题）

📢 域名与连接说明

✅ 正式环境：请使用 https://api.yddm.com 发起所有请求。

⚙️ 说明：更换基址后，请求路径、参数与鉴权方式保持不变。

⏱️ 请求耗时过长（超过 30 秒）？ 请适当加大客户端超时；必要时在本地配置代理以提升连接稳定性。

响应格式

接口统一返回 JSON：

{
  "code": 0,
  "msg": "success",
  "data": {}
}

code == 0：成功。

code != 0：失败，请以响应体中的 code、msg 为准（不要只看 HTTP 状态）。

业务状态码说明

状态码	说明
0	成功
400	参数错误
1001	账户余额不足
1002	邮箱/手机号或密码错误
1003	请求频率超过上限
1005	无效的 API Key
1007	登录凭证无效
1008	缺少 API Key
1019	接口不存在，请检查
1020	该接口未开通，请联系客服
2001	无法获取
5000	服务暂时不可用，请稍后重试
5003	网络连接失败，请稍后重试

部分平台接口需单独开通权限；未开通时返回 1020，请联系客服开通。

API 鉴权

业务接口须携带身份凭证，支持以下两种方式（二选一）。

方式一：请求头使用 API Key（推荐）

Header：X-API-Key

示例：X-API-Key: your_api_key

方式二：请求头使用 Bearer Token

Header：Authorization

格式：Bearer your_token

示例：Authorization: Bearer your_token

少数账号类接口仅支持 Bearer Token，以接口文档标注为准。

获取 API Key / Token

在控制台注册账号（https://www.yddm.com），或调用 POST /auth/register。

调用 GET /users/me（或在控制台）查看并复制 api_key。

请妥善保管密钥，仅在服务端请求头中使用，勿写入前端或公开仓库。

请求示例

平台接口多为 POST + JSON Body，路径与字段请查阅接口文档。

计费与余额

多数接口按次计费（金额单位为毫：1000 毫 = 1 元，具体以接口定价为准）。

余额不足返回 code=1001。

可在控制台充值；调用记录见 GET /users/get_api_records。

文档更新

接口以在线文档站为准。文档更新后，请重新打开文档页或刷新本地缓存后再对接。

自述文档 - 中文

【常用链接】#

📢 域名与连接说明#

响应格式#

业务状态码说明#

API 鉴权#

方式一：请求头使用 API Key（推荐）#

方式二：请求头使用 Bearer Token#

获取 API Key / Token#

请求示例#

计费与余额#

文档更新#