Appearance
API 认证
明道云 API 使用签名认证机制，需要在每个请求中包含认证信息。
V3 认证方式
API V3 使用请求头进行认证：
请求头
Appkey: {appkey}
Sign: {签名}获取 AppKey 和 Sign
- 登录明道云
- 进入「设置」-「开放平台」
- 创建 API Token
- 获取 AppKey 和 Sign（Sign 需要根据请求参数计算）
签名计算
签名（Sign）需要通过特定算法计算，确保请求的完整性和安全性。
V2 认证方式
API V2 支持两种认证方式：
方式一：URL 参数（GET 请求）
GET /api/v1/open/app/get?appKey={appKey}&sign={sign}方式二：请求体参数（POST 请求）
json
{
"appKey": "your_app_key",
"sign": "calculated_sign"
}获取 AppKey 和 Sign
- 登录明道云
- 进入「设置」-「开放平台」
- 创建 API Token
- 获取 AppKey 和 Sign
安全建议
- 定期更换 Token：建议每 3-6 个月更换一次
- 不要将 Token 提交到代码仓库：使用环境变量或配置文件管理
- 限制 Token 权限范围：只授予必要的应用和操作权限
- 使用 HTTPS：始终使用 HTTPS 协议进行 API 调用
- IP 白名单：如果可能，配置 IP 白名单限制访问来源
Token 权限
- 读取权限：可以查询数据
- 写入权限：可以创建、更新、删除数据
- 管理权限：可以管理应用配置
Token 过期
Token 默认永不过期，但可以手动设置过期时间。如果 Token 泄露或需要更换，可以在设置中重新生成。
相关文档
维护负责人：技术部
最后更新：2025-01-19