README - English - 云端点

本页也有中文版：自述文档 - 中文

Public guide for the YDDM (云端点) API. Endpoint details are in the online API docs.

Common links

🏡 Website / Console: https://www.yddm.com

🔌 API base URL: https://api.yddm.com

📚 API docs: https://docs.yddm.com/

🎫 Support: WeChat wx2026-maxiao (verification, access packages, billing, etc.)

Domain & connectivity

Production: Send all requests to https://api.yddm.com.

Note: If you change only the base URL, paths, parameters, and auth headers stay the same.

Slow requests (> 30s)? Increase your client timeout; configure a local proxy if needed for a more stable outbound connection.

Response format

APIs return JSON:

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

code == 0: Success.

code != 0: Failure — use the body code and msg (do not rely on HTTP status alone).

Common business status codes

Code	Meaning
0	Success
400	Invalid parameters
1001	Insufficient balance
1002	Wrong email/phone or password
1003	Rate limit exceeded
1005	Invalid API Key
1007	Invalid login credential
1008	Missing API Key
1019	Endpoint not found
1020	Endpoint not enabled — contact support
2001	Data unavailable
5000	Service temporarily unavailable
5003	Network error — retry later

Some platform endpoints require a separate access package. Without it you get 1020 — contact support to enable access.

Authentication

Business endpoints require credentials. Use one of the following.

Option 1: API Key header (recommended)

Header: X-API-Key

Example: X-API-Key: your_api_key

Option 2: Bearer token

Header: Authorization

Format: Bearer your_token

Example: Authorization: Bearer your_token

A few account-related endpoints accept Bearer only. Follow each endpoint’s docs.

How to get an API Key / token

Call GET /users/me (or use the console) and copy api_key.

Keep the key secret. Use it only in server-side request headers — never ship it in frontend code or public repos.

Request examples

Most platform endpoints are POST with a JSON body. Paths and fields are documented in the API docs site.

Billing & balance

Most endpoints are charged per call (unit: milli; 1000 milli = 1 CNY — see pricing for each endpoint).

Insufficient balance returns code=1001.

Top up in the console; call history is available via GET /users/get_api_records.

Doc updates

The online docs site is the source of truth. After docs are updated, reopen the page or refresh any local cache before integrating.

README - English

Common links#

Domain & connectivity#

Response format#

Common business status codes#

Authentication#

Option 1: API Key header (recommended)#

Option 2: Bearer token#

How to get an API Key / token#

Request examples#

Billing & balance#

Doc updates#