Maintainers
Pricing
Enterprise
More
More
Documentation
Try Live
Rankings
Install
Blog
Docs7
Ask
New
Add Docs
星筱网络验证
https://www.xxauth.com/docs/api
Admin
星筱网络验证（XXAuth）是一个面向软件开发者的云端授权与网络验证平台，提供卡密验证、用户管理、版本更新检测、在线统计和云配置等开放 API 接口。
Tokens:
13,451
Snippets:
83
Trust Score:
2.7
Update:
1 month ago
Context
Chat
Benchmark
Latest
Show doc for...
Code
Info
Show Results
Tokens:
Raw
Copy
Link
Tokens:
Raw
Copy
Link
### Get Recommended Configurations Response Source: https://www.xxauth.com/docs/api Example response for the GET /open/v1/cloud-configs/pools/:pid/recommended endpoint. ```json { "code": 0, "message": "success", "data": [ { "id": "cfg_xxxx", "title": "推荐配置1", "content": "{}", "owner_type": "official", "created_at": "2026-01-01T00:00:00Z" } ] } ``` -------------------------------- ### GET /open/v1/init Source: https://www.xxauth.com/docs/api 初始化聚合接口，用于获取软件基础信息、授权模式、限制策略、更新信息及公告等。 ```APIDOC ## GET /open/v1/init ### Description 初始化聚合接口，用于获取软件基础信息、授权模式、限制策略、更新信息及公告等。 ### Method GET ### Endpoint /open/v1/init ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID - **card_no** (string) - Optional - 卡密号 - **user_id** (string) - Optional - 用户ID - **X-Anon-ID** (string) - Optional - 匿名设备ID #### Query Parameters - **platform** (string) - Optional - 平台（windows/mac/android/ios），默认 windows ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应消息 - **data** (object) - 初始化数据对象 ``` -------------------------------- ### List Private Configurations Response Source: https://www.xxauth.com/docs/api Example response for the GET /open/v1/cloud-configs/pools/:pid/mine endpoint. ```json { "code": 0, "message": "success", "data": { "list": [ { "id": "cfg_xxxx", "title": "我的私人配置", "content": "{...}", "status": 1, "created_at": "2026-01-01T00:00:00Z" } ], "total": 1, "page": 1, "page_size": 20 } } ``` -------------------------------- ### Get Single Configuration Response Source: https://www.xxauth.com/docs/api Example response for the GET /open/v1/cloud-configs/configs/:cid endpoint. ```json { "code": 0, "message": "success", "data": { "id": "cfg_xxxx", "title": "配置标题", "content": "{...}", "owner_type": "user", "owner_id": "usr_xxxx", "status": 1, "created_at": "2026-01-01T00:00:00Z" } } ``` -------------------------------- ### List Cloud Configuration Pools Response Source: https://www.xxauth.com/docs/api Example response for the GET /open/v1/cloud-configs/pools endpoint. ```json { "code": 0, "message": "success", "data": [ { "id": "pool_xxxx", "name": "默认规则池", "description": "保存核心规则", "max_configs_per_user": 10, "max_content_size": 102400, "allow_share_password": true, "allow_share_limit": true } ] } ``` -------------------------------- ### 初始化接口响应示例 Source: https://www.xxauth.com/docs/api GET /open/v1/init 接口的返回数据结构，包含软件信息、认证模式、限制策略及安全配置等。 ```json { "code": 0, "message": "success", "data": { "software": { "id": "sw_xxxx", "name": "我的软件", "icon": "https://cdn/icon.png", "pricing_mode": "paid" }, "auth": { "login_mode": "user", "register_enabled": "true" }, "limit": { "max_devices": 3, "max_online": 1 }, "update": { "default_strategy": "optional", "update_notice": "" }, "status_codes": { "card_expired": "1001" }, "variables": { "max_devices": "3" }, "security": { "anti_debug": false, "heartbeat_interval": 60, "heartbeat_verify_machine": false, "heartbeat_verify_ip": false, "encrypt_algorithm": "aes-cbc" }, "announcements": [ { "id": "ann_xxxx", "title": "公告标题", "content": "公告内容" } ], "latest_version": { "version": "1.2.0", "download_url": "https://example.com/app-1.2.0.exe" }, "pricing_mode": "paid", "anon_id": "" } } ``` -------------------------------- ### GET /open/v1/user/info Source: https://www.xxauth.com/docs/api 获取用户信息接口。 ```APIDOC ## GET /open/v1/user/info ### Description 获取用户信息。 ### Method GET ### Endpoint /open/v1/user/info ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Query Parameters - **user_id** (string) - Required - 用户ID ### Response #### Success Response (200) - **id** (string) - 用户ID - **username** (string) - 用户名 - **nickname** (string) - 昵称 - **vip_level** (integer) - VIP等级 - **vip_expire_at** (string) - VIP过期时间 - **balance** (integer) - 余额 - **last_login_ip** (string) - 最后登录IP - **created_at** (string) - 创建时间 ``` -------------------------------- ### GET /open/v1/config/:category Source: https://www.xxauth.com/docs/api 按分类获取软件配置信息，支持 auth、limit、update、status_code、variable 等分类。 ```APIDOC ## GET /open/v1/config/:category ### Description 按分类获取软件配置信息，支持 auth、limit、update、status_code、variable 等分类。security 与 agent 分类受保护，不可访问。 ### Method GET ### Endpoint /open/v1/config/:category ### Parameters #### Path Parameters - **category** (string) - Required - 配置分类（auth/limit/update/status_code/variable） #### Header Parameters - **app_id** (string) - Required - 应用ID - **card_no** (string) - Optional - 卡密号 - **user_id** (string) - Optional - 用户ID ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应消息 - **data** (object) - 配置数据对象 ``` -------------------------------- ### GET /open/v1/version/latest Source: https://www.xxauth.com/docs/api Retrieves the latest version information. ```APIDOC ## GET /open/v1/version/latest ### Description Retrieves the latest version information. ### Method GET ### Endpoint /open/v1/version/latest ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID #### Query Parameters - **platform** (string) - Optional - Platform, default windows ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (object) - Version details #### Response Example { "code": 0, "message": "success", "data": { "version": "1.2.0", "download_url": "https://example.com/app-1.2.0.exe", "change_log": "修复了若干问题", "file_size": 10485760, "platform": "windows" } } ``` -------------------------------- ### GET /open/v1/cloud-configs/pools/:pid/recommended Source: https://www.xxauth.com/docs/api Retrieves the list of official recommended configurations within a pool. ```APIDOC ## GET /open/v1/cloud-configs/pools/:pid/recommended ### Description Fetches official recommended configurations for a specific pool. ### Method GET ### Endpoint /open/v1/cloud-configs/pools/:pid/recommended ### Parameters #### Path Parameters - **pid** (uuid) - Required - Pool ID #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number - **user_id** (string) - Optional - User ID ### Response #### Success Response (200) - **data** (array) - List of recommended configurations. ``` -------------------------------- ### GET /open/v1/banners Source: https://www.xxauth.com/docs/api Retrieves the list of startup page banners. ```APIDOC ## GET /open/v1/banners ### Description Retrieves the list of startup page banners. ### Method GET ### Endpoint /open/v1/banners ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (array) - List of banners #### Response Example { "code": 0, "message": "success", "data": [ { "id": "bnr_xxxx", "image": "https://cdn/banner.png", "link": "https://...", "title": "活动标题", "sort_order": 0 } ] } ``` -------------------------------- ### 按分类获取配置接口响应示例 Source: https://www.xxauth.com/docs/api GET /open/v1/config/:category 接口的返回数据结构，用于获取指定分类的配置信息。 ```json { "code": 0, "message": "success", "data": { "max_devices": "3", "max_online": "1" } } ``` -------------------------------- ### GET /open/v1/crypto/algorithms Source: https://www.xxauth.com/docs/api Lists the encryption and hash algorithms supported by the backend. ```APIDOC ## GET /open/v1/crypto/algorithms ### Description Lists the encryption and hash algorithms supported by the backend. ### Method GET ### Endpoint /open/v1/crypto/algorithms ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应信息 - **data** (object) - 包含 cipher 和 hash 列表的响应数据 #### Response Example { "code": 0, "message": "success", "data": { "cipher": ["aes-cbc", "aes-gcm", "sm4-cbc"], "hash": ["md5", "sha1", "sha256", "sha512", "sm3"] } } ``` -------------------------------- ### GET /open/v1/cloud-configs/pools Source: https://www.xxauth.com/docs/api Lists all enabled configuration pools for the software. ```APIDOC ## GET /open/v1/cloud-configs/pools ### Description Retrieves a list of all enabled configuration pools. ### Method GET ### Endpoint /open/v1/cloud-configs/pools ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number (required if cloud_config_auth_required is enabled) - **user_id** (string) - Optional - User ID (required if cloud_config_auth_required is enabled) ### Response #### Success Response (200) - **data** (array) - List of configuration pools. ``` -------------------------------- ### Create Private Configuration Response Source: https://www.xxauth.com/docs/api Example response for the POST /open/v1/cloud-configs/pools/:pid/configs endpoint. ```json { "code": 0, "message": "success", "data": { "id": "cfg_xxxx", "title": "我的配置", "content": "{}", "status": 1 } } ``` -------------------------------- ### GET /open/v1/version/list Source: https://www.xxauth.com/docs/api Retrieves a list of versions sorted by published date. ```APIDOC ## GET /open/v1/version/list ### Description Retrieves a list of versions sorted by published date. ### Method GET ### Endpoint /open/v1/version/list ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID #### Query Parameters - **platform** (string) - Optional - Platform filter ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (array) - List of versions #### Response Example { "code": 0, "message": "success", "data": [ { "id": "ver_xxxx", "version": "1.2.0", "platform": "windows", "channel": "stable", "status": 1, "push_enabled": true, "download_url": "https://...", "change_log": "...", "file_size": 10485760, "published_at": "2026-01-01T00:00:00Z" } ] } ``` -------------------------------- ### GET /open/v1/articles Source: https://www.xxauth.com/docs/api Retrieves the list of articles. ```APIDOC ## GET /open/v1/articles ### Description Retrieves the list of articles. ### Method GET ### Endpoint /open/v1/articles ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (array) - List of articles #### Response Example { "code": 0, "message": "success", "data": [ { "id": "art_xxxx", "title": "文章标题", "summary": "摘要", "content": "内容", "category": "教程", "created_at": "2026-01-01T00:00:00Z" } ] } ``` -------------------------------- ### GET /open/v1/cloud-configs/configs/:cid Source: https://www.xxauth.com/docs/api Retrieves a single configuration by ID. ```APIDOC ## GET /open/v1/cloud-configs/configs/:cid ### Description Gets the full content of a specific configuration. ### Method GET ### Endpoint /open/v1/cloud-configs/configs/:cid ### Parameters #### Path Parameters - **cid** (uuid) - Required - Configuration ID #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number - **user_id** (string) - Optional - User ID ### Response #### Success Response (200) - **data** (object) - Configuration details. ``` -------------------------------- ### 获取单码卡密信息响应示例 Source: https://www.xxauth.com/docs/api GET /open/v1/card/info 接口的成功响应，返回卡密的详细状态及绑定信息。 ```json { "code": 0, "message": "success", "data": { "card_no": "XXXX-XXXX-XXXX", "status": 1, "expires_at": "2026-04-17T00:00:00Z", "bound_ip": "1.2.3.4", "bound_machine_code": "ABC123", "duration": 720, "created_at": "2026-01-01T00:00:00Z" } } ``` -------------------------------- ### GET /open/v1/announcements Source: https://www.xxauth.com/docs/api Retrieves the list of program announcements. ```APIDOC ## GET /open/v1/announcements ### Description Retrieves the list of program announcements. ### Method GET ### Endpoint /open/v1/announcements ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (array) - List of announcements #### Response Example { "code": 0, "message": "success", "data": [ { "id": "ann_xxxx", "title": "公告标题", "content": "公告内容", "priority": 1, "created_at": "2026-01-01T00:00:00Z" } ] } ``` -------------------------------- ### GET /open/v1/variables Source: https://www.xxauth.com/docs/api Retrieves all program variables defined in the configuration management. ```APIDOC ## GET /open/v1/variables ### Description Retrieves all program variables defined in the configuration management. ### Method GET ### Endpoint /open/v1/variables ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number (required if variables_auth_required is enabled) - **user_id** (string) - Optional - User ID (required if variables_auth_required is enabled) ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (array) - List of variables #### Response Example { "code": 0, "message": "success", "data": [ { "key": "max_devices", "value": "3", "remark": "最大设备数" } ] } ``` -------------------------------- ### Update Private Configuration Response Source: https://www.xxauth.com/docs/api Example response for the PUT /open/v1/cloud-configs/configs/:cid endpoint. ```json { "code": 0, "message": "success", "data": { "id": "cfg_xxxx", "title": "新标题", "content": "{...}" } } ``` -------------------------------- ### 卡密状态检查响应示例 Source: https://www.xxauth.com/docs/api GET /open/v1/card/check 接口的轻量级响应，仅返回卡密是否有效及状态文本。 ```json { "code": 0, "message": "success", "data": { "valid": true, "status": 1, "status_text": "已使用" } } ``` -------------------------------- ### GET /open/v1/cloud-configs/pools/:pid/mine Source: https://www.xxauth.com/docs/api Lists private configurations for the current card or user. ```APIDOC ## GET /open/v1/cloud-configs/pools/:pid/mine ### Description Lists private configurations associated with the provided card or user ID. ### Method GET ### Endpoint /open/v1/cloud-configs/pools/:pid/mine ### Parameters #### Path Parameters - **pid** (uuid) - Required - Pool ID #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number - **user_id** (string) - Optional - User ID #### Query Parameters - **page** (int) - Optional - Page number - **page_size** (int) - Optional - Items per page ### Response #### Success Response (200) - **data** (object) - Paginated list of configurations. ``` -------------------------------- ### GET /open/v1/card/info Source: https://www.xxauth.com/docs/api Retrieves detailed information about a specific card. ```APIDOC ## GET /open/v1/card/info ### Description Retrieves detailed information about a specific card. ### Method GET ### Endpoint /open/v1/card/info ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Query Parameters - **card_no** (string) - Required - 卡密号 ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 提示信息 - **data** (object) - 包含卡密详细信息 ### Response Example { "code": 0, "message": "success", "data": { "card_no": "XXXX-XXXX-XXXX", "status": 1, "expires_at": "2026-04-17T00:00:00Z", "bound_ip": "1.2.3.4", "bound_machine_code": "ABC123", "duration": 720, "created_at": "2026-01-01T00:00:00Z" } } ``` -------------------------------- ### GET /open/v1/card/check Source: https://www.xxauth.com/docs/api Performs a lightweight status check on a card. ```APIDOC ## GET /open/v1/card/check ### Description Performs a lightweight status check on a card. ### Method GET ### Endpoint /open/v1/card/check ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Query Parameters - **card_no** (string) - Required - 卡密号 ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 提示信息 - **data** (object) - 包含状态信息 ### Response Example { "code": 0, "message": "success", "data": { "valid": true, "status": 1, "status_text": "已使用" } } ``` -------------------------------- ### Execute Cloud Logic API Response Source: https://www.xxauth.com/docs/api Example response for the POST /open/v1/execute endpoint. ```json { "code": 0, "message": "success", "data": { "function": "calcLicense", "output": "abc123", "error": "", "time_ms": 12 } } ``` -------------------------------- ### GET /open/v1/stats/online-users Source: https://www.xxauth.com/docs/api Retrieves the count of currently online users. ```APIDOC ## GET /open/v1/stats/online-users ### Description Retrieves the count of currently online users. ### Method GET ### Endpoint /open/v1/stats/online-users ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应信息 - **data** (object) - 包含 count 字段的响应数据 #### Response Example { "code": 0, "message": "success", "data": { "count": 128 } } ``` -------------------------------- ### Delete Private Configuration Response Source: https://www.xxauth.com/docs/api Example response for the DELETE /open/v1/cloud-configs/configs/:cid endpoint. ```json { "code": 0, "message": "success", "data": { "ok": true } } ``` -------------------------------- ### Secure Transport API Response Source: https://www.xxauth.com/docs/api Example response for the POST /open/v1/secure endpoint. ```json { "code": 0, "message": "success", "data": { "encrypted": "Base64(密文(原 OpenAPI 响应))" } } ``` -------------------------------- ### GET /open/v1/stats/online-cards Source: https://www.xxauth.com/docs/api Retrieves the count of currently online cards. ```APIDOC ## GET /open/v1/stats/online-cards ### Description Retrieves the count of currently online cards. ### Method GET ### Endpoint /open/v1/stats/online-cards ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应信息 - **data** (object) - 包含 count 字段的响应数据 #### Response Example { "code": 0, "message": "success", "data": { "count": 42 } } ``` -------------------------------- ### Get Online Statistics Responses Source: https://www.xxauth.com/docs/api Response formats for online card and user count retrieval endpoints. ```json { "code": 0, "message": "success", "data": { "count": 42 } } ``` ```json { "code": 0, "message": "success", "data": { "count": 128 } } ``` -------------------------------- ### POST /open/v1/user/register Source: https://www.xxauth.com/docs/api 用户注册接口。 ```APIDOC ## POST /open/v1/user/register ### Description 用户注册接口。 ### Method POST ### Endpoint /open/v1/user/register ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **username** (string) - Required - 用户名 - **password** (string) - Required - 密码 - **nickname** (string) - Optional - 昵称 - **email** (string) - Optional - 邮箱 - **email_code** (string) - Optional - 邮箱验证码 - **captcha_token** (string) - Optional - 图形验证码 token - **captcha_value** (string) - Optional - 图形验证码值 ### Response #### Success Response (200) - **user_id** (string) - 用户ID - **username** (string) - 用户名 - **nickname** (string) - 昵称 - **vip_level** (integer) - VIP等级 - **vip_expire_at** (string) - VIP过期时间 ``` -------------------------------- ### POST /open/v1/user/login Source: https://www.xxauth.com/docs/api 用户登录接口。 ```APIDOC ## POST /open/v1/user/login ### Description 用户登录接口。 ### Method POST ### Endpoint /open/v1/user/login ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **username** (string) - Required - 用户名 - **password** (string) - Required - 密码 - **machine_code** (string) - Optional - 机器码 - **email_code** (string) - Optional - 邮箱验证码 - **captcha_token** (string) - Optional - 图形验证码 token - **captcha_value** (string) - Optional - 图形验证码值 ### Response #### Success Response (200) - **user_id** (string) - 用户ID - **username** (string) - 用户名 - **nickname** (string) - 昵称 - **vip_level** (integer) - VIP等级 - **vip_expire_at** (string) - VIP过期时间 - **balance** (integer) - 余额 ``` -------------------------------- ### POST /open/v1/cloud-configs/pools/:pid/configs Source: https://www.xxauth.com/docs/api Creates a new private configuration. ```APIDOC ## POST /open/v1/cloud-configs/pools/:pid/configs ### Description Creates a new private configuration in the specified pool. ### Method POST ### Endpoint /open/v1/cloud-configs/pools/:pid/configs ### Parameters #### Path Parameters - **pid** (uuid) - Required - Pool ID #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number - **user_id** (string) - Optional - User ID #### Request Body - **title** (string) - Required - Configuration title - **content** (string) - Optional - Configuration content ### Response #### Success Response (200) - **data** (object) - Created configuration details. ``` -------------------------------- ### POST /open/v1/cloud-configs/import Source: https://www.xxauth.com/docs/api Imports a configuration using a share code, automatically assigning it to the current user. ```APIDOC ## POST /open/v1/cloud-configs/import ### Description Imports a configuration using a share code, automatically assigning it to the current user. ### Method POST ### Endpoint /open/v1/cloud-configs/import ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID - **card_no** (string) - Optional - 卡密号（与 user_id 二选一） - **user_id** (string) - Optional - 用户ID #### Request Body - **share_code** (string) - Required - 分享码 - **password** (string) - Optional - 分享密码（若设置了） ### Response #### Success Response (200) - **code** (int) - 状态码 - **message** (string) - 响应信息 - **data** (object) - 包含 id, title, content 的配置详情 #### Response Example { "code": 0, "message": "success", "data": { "id": "cfg_xxxx", "title": "已导入配置", "content": "{...}" } } ``` -------------------------------- ### POST /open/v1/version/check Source: https://www.xxauth.com/docs/api Checks if the current version is the latest, supporting gray release, forced updates, and channels. ```APIDOC ## POST /open/v1/version/check ### Description Checks if the current version is the latest, supporting gray release, forced updates, and channels. ### Method POST ### Endpoint /open/v1/version/check ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID #### Request Body - **version** (string) - Required - Current version number - **platform** (string) - Optional - Platform, default windows - **channel** (string) - Optional - Update channel: stable/beta/alpha, default stable - **device_id** (string) - Optional - Device identifier for gray release calculation ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (object) - Update check result #### Response Example { "code": 0, "message": "success", "data": { "is_latest": false, "latest_version": "1.2.0", "download_url": "https://example.com/app-1.2.0.exe", "change_log": "修复了若干问题", "update_strategy": "optional", "force_update": false, "channel": "stable", "published_at": "2026-01-01T00:00:00Z", "rollout_percent": 100, "file_size": 10485760, "file_hash": "sha256:xxxxxx", "update_notice": "升级提示文案" } } ``` -------------------------------- ### POST /open/v1/user/unbind-device Source: https://www.xxauth.com/docs/api 用户解绑机器码接口。 ```APIDOC ## POST /open/v1/user/unbind-device ### Description 用户解绑机器码（需校验密码）。 ### Method POST ### Endpoint /open/v1/user/unbind-device ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID - **password** (string) - Required - 账户密码 ``` -------------------------------- ### POST /open/v1/user/recharge Source: https://www.xxauth.com/docs/api 用户卡密充值接口。 ```APIDOC ## POST /open/v1/user/recharge ### Description 用户充值（卡密充值）。 ### Method POST ### Endpoint /open/v1/user/recharge ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID - **card_no** (string) - Required - 卡密号 ### Response #### Success Response (200) - **message** (string) - 提示信息 - **added_hours** (integer) - 增加时长 - **new_vip_expire_at** (string) - 新过期时间 ``` -------------------------------- ### Configuration Import Response Source: https://www.xxauth.com/docs/api The JSON response structure returned after successfully importing a configuration via a share code. ```json { "code": 0, "message": "success", "data": { "id": "cfg_xxxx", "title": "已导入配置", "content": "{...}" } } ``` -------------------------------- ### POST /open/v1/execute Source: https://www.xxauth.com/docs/api Executes a pre-defined cloud logic script by function name. ```APIDOC ## POST /open/v1/execute ### Description Executes a cloud logic script defined in the developer backend. ### Method POST ### Endpoint /open/v1/execute ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID #### Request Body - **function** (string) - Required - Cloud logic function name - **params** (object) - Optional - Parameters passed to the function ### Response #### Success Response (200) - **code** (int) - Status code - **message** (string) - Status message - **data** (object) - Execution result containing function name, output, error, and execution time. ``` -------------------------------- ### POST /open/v1/user/send-email-code Source: https://www.xxauth.com/docs/api 发送邮箱验证码用于注册或登录场景。 ```APIDOC ## POST /open/v1/user/send-email-code ### Description 发送邮箱验证码（注册/登录）。当软件「安全配置」开启『注册邮箱验证』或『登录邮箱验证』时，调用注册/登录前先用本接口获取验证码。 ### Method POST ### Endpoint /open/v1/user/send-email-code ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **scene** (string) - Required - 场景：register（注册）或 login（登录） - **email** (string) - Optional - register 场景必填，接收验证码的邮箱 - **username** (string) - Optional - login 场景必填，后端据此查出账号绑定邮箱 ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 提示信息 - **data** (null) - 数据 ``` -------------------------------- ### POST /open/v1/card/login Source: https://www.xxauth.com/docs/api Performs a login operation using a card key. ```APIDOC ## POST /open/v1/card/login ### Description Performs a login operation using a card key. ### Method POST ### Endpoint /open/v1/card/login ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **card_no** (string) - Required - 卡密号 - **machine_code** (string) - Optional - 机器码 - **timestamp** (string) - Optional - 时间戳 ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 提示信息 - **data** (object) - 包含卡密详细信息 ### Response Example { "code": 0, "message": "success", "data": { "card_id": "crd_xxxx", "card_no": "XXXX-XXXX-XXXX", "expires_at": "2026-04-17T00:00:00Z", "bound_ip": "1.2.3.4", "bound_machine_code": "ABC123", "software_id": "sw_xxxx" } } ``` -------------------------------- ### POST /open/v1/user/change-password Source: https://www.xxauth.com/docs/api 用户修改密码接口。 ```APIDOC ## POST /open/v1/user/change-password ### Description 用户修改密码。 ### Method POST ### Endpoint /open/v1/user/change-password ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID - **old_password** (string) - Required - 旧密码 - **new_password** (string) - Required - 新密码 ``` -------------------------------- ### 获取最新版本号响应示例 Source: https://www.xxauth.com/docs/api 返回当前最新版本信息，包括下载地址及更新日志。 ```json { "code": 0, "message": "success", "data": { "version": "1.2.0", "download_url": "https://example.com/app-1.2.0.exe", "change_log": "修复了若干问题", "file_size": 10485760, "platform": "windows" } } ``` -------------------------------- ### POST /open/v1/user/logout Source: https://www.xxauth.com/docs/api 用户注销接口。 ```APIDOC ## POST /open/v1/user/logout ### Description 用户注销。 ### Method POST ### Endpoint /open/v1/user/logout ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID ``` -------------------------------- ### PUT /open/v1/cloud-configs/configs/:cid Source: https://www.xxauth.com/docs/api Updates an existing private configuration. ```APIDOC ## PUT /open/v1/cloud-configs/configs/:cid ### Description Updates the title or content of an existing private configuration. ### Method PUT ### Endpoint /open/v1/cloud-configs/configs/:cid ### Parameters #### Path Parameters - **cid** (uuid) - Required - Configuration ID #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number - **user_id** (string) - Optional - User ID #### Request Body - **title** (string) - Optional - New title - **content** (string) - Optional - New content ### Response #### Success Response (200) - **data** (object) - Updated configuration details. ``` -------------------------------- ### Configuration Share Response Source: https://www.xxauth.com/docs/api The JSON response structure returned after successfully sharing a configuration. ```json { "code": 0, "message": "success", "data": { "share_code": "abcd1234", "share_password": "", "share_limit": 10, "share_used": 0 } } ``` -------------------------------- ### POST /open/v1/secure Source: https://www.xxauth.com/docs/api Proxies and forwards encrypted internal requests. ```APIDOC ## POST /open/v1/secure ### Description Proxies an encrypted internal request. ### Method POST ### Endpoint /open/v1/secure ### Parameters #### Header Parameters - **app_id** (string) - Required - Application ID #### Request Body - **encrypted** (string) - Required - Base64 encoded encrypted JSON containing path, method, body, and params ### Response #### Success Response (200) - **code** (int) - Status code - **message** (string) - Status message - **data** (object) - Contains the encrypted response. ``` -------------------------------- ### POST /open/v1/variable/:key Source: https://www.xxauth.com/docs/api Retrieves a single program variable by its key. ```APIDOC ## POST /open/v1/variable/:key ### Description Retrieves a single program variable by its key. ### Method POST ### Endpoint /open/v1/variable/:key ### Parameters #### Path Parameters - **key** (string) - Required - Variable key #### Header Parameters - **app_id** (string) - Required - Application ID - **card_no** (string) - Optional - Card number (required if variables_auth_required is enabled) - **user_id** (string) - Optional - User ID (required if variables_auth_required is enabled) ### Response #### Success Response (200) - **code** (integer) - Status code - **message** (string) - Status message - **data** (object) - Variable details #### Response Example { "code": 0, "message": "success", "data": { "key": "max_devices", "value": "3" } } ``` -------------------------------- ### POST /open/v1/app/verify-sign Source: https://www.xxauth.com/docs/api Verifies the application signature by comparing the provided sign value. ```APIDOC ## POST /open/v1/app/verify-sign ### Description Verifies the application signature by comparing the provided sign value. ### Method POST ### Endpoint /open/v1/app/verify-sign ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **sign** (string) - Required - 签名值 ### Response #### Success Response (200) - **code** (integer) - 状态码 - **message** (string) - 响应信息 - **data** (object) - 包含 valid 字段的响应数据 #### Response Example { "code": 0, "message": "success", "data": { "valid": true } } ``` -------------------------------- ### POST /open/v1/user/heartbeat Source: https://www.xxauth.com/docs/api 用户心跳验证接口。 ```APIDOC ## POST /open/v1/user/heartbeat ### Description 用户心跳验证。 ### Method POST ### Endpoint /open/v1/user/heartbeat ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID - **machine_code** (string) - Optional - 机器码 ### Response #### Success Response (200) - **valid** (boolean) - 是否有效 ``` -------------------------------- ### 用户充值 API 响应 Source: https://www.xxauth.com/docs/api 卡密充值成功后的返回数据，包含充值时长及更新后的过期时间。 ```json { "code": 0, "message": "success", "data": { "message": "充值成功", "added_hours": 720, "new_vip_expire_at": "2026-05-01T00:00:00Z" } } ``` -------------------------------- ### Open API 鉴权请求示例 Source: https://www.xxauth.com/docs/api 所有 Open API 接口均通过 HTTP 请求头 app_id 进行鉴权。 ```http GET /open/v1/announcements HTTP/1.1 Host: api.xxauth.com app_id: your_app_id_here ``` -------------------------------- ### 解绑操作响应示例 Source: https://www.xxauth.com/docs/api POST /open/v1/card/unbind-device 和 POST /open/v1/card/unbind-ip 接口的通用成功响应。 ```json { "code": 0, "message": "success", "data": null } ``` -------------------------------- ### 用户登录 API 响应 Source: https://www.xxauth.com/docs/api 用户登录成功后的返回数据，包含账户余额及 VIP 过期时间。 ```json { "code": 0, "message": "success", "data": { "user_id": "usr_xxxx", "username": "test", "nickname": "test", "vip_level": 1, "vip_expire_at": "2026-05-01T00:00:00Z", "balance": 0 } } ``` -------------------------------- ### POST /open/v1/user/unbind-ip Source: https://www.xxauth.com/docs/api 用户解绑IP接口。 ```APIDOC ## POST /open/v1/user/unbind-ip ### Description 用户解绑IP。 ### Method POST ### Endpoint /open/v1/user/unbind-ip ### Parameters #### Header Parameters - **app_id** (string) - Required - 应用ID #### Request Body - **user_id** (string) - Required - 用户ID - **password** (string) - Required - 账户密码 ``` -------------------------------- ### 用户解绑设备与 IP API 响应 Source: https://www.xxauth.com/docs/api 解绑设备或 IP 后的响应，包含扣除费用及剩余余额信息。 ```json { "code": 0, "message": "success", "data": { "deducted_fee_cent": 0, "deducted_hours": 0, "balance": 1500, "vip_expire_at": "2026-05-01T00:00:00Z" } } ``` -------------------------------- ### 按名称获取单个程序变量响应示例 Source: https://www.xxauth.com/docs/api 返回指定 key 的单个变量值，若不存在则返回 404。 ```json { "code": 0, "message": "success", "data": { "key": "max_devices", "value": "3" } } ```
