快速开始
- 从首页点击 用户中心,使用平台账号登录;没有账号时先注册。
- 进入用户中心后,先在 应用管理 → 应用列表 创建一个应用。
- 记录应用的 应用密钥,调用 API 时作为业务参数
Softid传入。 - 按你的业务选择管理方式:账号授权使用“用户管理”,独立卡密授权使用“单码管理”。
- 需要联调时进入 测试中心 → API测试,选择接口并填写带
Softid的业务参数后直接测试。
应用管理
应用是所有授权数据的归属单位。一个平台账号可以创建多个应用,每个应用的数据相互隔离。
| 功能 | 说明 |
|---|---|
| 应用列表 | 创建、编辑和删除自己的应用,查看应用密钥、登录方式、加密和签名配置。 |
| 版本管理 | 维护客户端版本信息、更新地址和更新说明。 |
| 云端变量 | 保存客户端可读取的动态变量,用于开关、配置或提示信息。 |
| 公告管理 | 发布应用公告,客户端可通过公告接口读取。 |
| MD5 管理 | 维护程序 MD5,用于客户端完整性校验。 |
| 应用日志 | 查看当前应用的接口调用和登录相关记录。 |
用户管理
用户管理用于维护“账号密码授权”模式下的客户端授权账号。
用户列表
- 可按应用、状态、是否过期、用户名或机器码搜索。
- 可添加、编辑、禁用、解禁、解绑或删除授权用户。
- 添加或编辑用户时可设置密码、剩余点数、账号多开、到期时间、云数据、私有数据和封禁原因。
单码管理
单码适合做独立许可证或卡密授权。单码第一次校验时激活,并按照设置的有效期和多开数量进行后续校验。
| 操作 | 说明 |
|---|---|
| 添加单码卡密 | 选择应用、卡密类型、有效数量、单码多开、卡头和生成数量。 |
| 编辑单码 | 修改单码内容、状态、机器码、到期时间、云数据、私有数据、备注等。 |
| 批量操作 | 支持解绑、禁用、解禁、冻结、解冻、删除和导出。 |
单码接口必填项
安全管理
安全管理目前包含黑名单功能。黑名单按应用关联,只影响选中应用。
- 类型支持:账号、设备码、设备 IP、自定义。
- 添加黑名单时必须选择所属应用。
- 客户端可通过
getblack查询黑名单,也可通过setblack写入黑名单。
接口与测试
接口列表
在 接口管理 → 接口列表 可以查看可用接口、调用地址和详细说明。点击“详细说明”可查看参数格式、POST 示例和返回值说明。
API 测试
在 测试中心 → API测试 可以选择应用和接口,填写业务参数后点击测试。系统会显示真实 POST 内容和接口返回数据。
测试中心会自动补充时间戳 t,并根据应用配置生成签名。
签名规则
如果应用开启了签名校验,真实 POST 时需要提交 sign。
data是最终提交给api.php的 data 原文。appkey是应用列表里的应用密钥。- 生成签名时的 data 必须和实际 POST 的 data 完全一致,包括参数顺序、大小写和编码结果。
POST 示例
查询授权用户时填写 UserPwd;查询单码时 UserName 填单码,UserPwd 留空。
加密说明
应用开启 RC4、RSA2、AES 或 Base64 后,只处理 POST 字段里的 data 和接口返回里的 msg。act、sign 仍然按普通表单字段提交。
- 先把业务参数组装成原始
data,例如Softid=应用密钥&Card=单码&t=当前时间戳。 - 按应用的加密配置处理原始
data,得到最终要提交的data。 - 使用“最终提交的 data”计算
sign = md5(data + appkey),不要用加密前的明文 data 计算签名。 - 接口返回后,如果应用启用了加密,需要先解码
msg,再按字符串或 JSON 使用。
RC4 模式
RC4 使用应用配置里的 RC4 密钥。请求时加密原始 data,返回时用同一密钥解密 msg。
Base64 模式
Base64 模式不需要额外密钥,请求时对原始 data 做 Base64 编码,返回时对 msg 做 Base64 解码。
RSA2 模式
RSA2 使用应用配置里的公钥和私钥。客户端请求时使用 RSA公钥 分段加密原始 data,再对密文整体做 Base64;服务端返回时会使用 RSA私钥 加密 msg,客户端使用同一组 RSA公钥 解密返回值。
AES 模式
AES 是推荐的新加密方式,使用 AES-256-CBC。密钥为应用里的“加密密钥”,请求和返回格式均为 base64(iv + ciphertext),其中 iv 为每次随机生成的 16 字节初始化向量。
SDK 下载
推荐客户直接使用官方 SDK 接入 RC4、RSA2 或 AES 模式,不再提供 PHP 版本 SDK。
| 语言 | RC4 SDK | RSA2 SDK | AES SDK |
|---|---|---|---|
| C++ | 下载 | 下载 | 下载 |
| Python | 下载 | 下载 | 下载 |
| 易语言 | 下载 | 下载 | 下载 |
| C# | 下载 | 下载 | 下载 |
| Java | 下载 | 下载 | 下载 |
msg 原本是对象,服务端会先转成 JSON 字符串再加密;客户端解码后可按需要再执行 JSON 解析。常见问题
提示“签名有误”
检查应用是否开启签名。若开启,确认 sign 是否按 md5(data + appkey) 生成,并确认生成签名的 data 与实际提交的 data 完全一致。
单码接口提示密钥错误
确认业务参数中包含 Softid=应用密钥,并且使用的是当前应用的密钥。
用户中心看不到数据
确认数据是否属于当前登录账号创建的应用。用户中心不会显示其他平台用户或管理员创建的应用数据。
API 测试没有返回预期结果
先在接口列表查看详细说明,确认接口标识、业务参数和应用配置。账号登录类接口通常需要先创建授权用户。