跳转至

集成开发概览

本文从开发者视角介绍 MagikCloud 开放平台 API 的集成开发流程。调用前请在网页端获取 AccessKeyID / SecretAccessKey(AK/SK),并在每次请求中附带数字签名;接口基址为 https://openapi.magikcloud.cn

1. 获取 AK/SK

MagikCloud 登录后,进入 密钥管理(导航里未直接展示,请用此链接):

  1. 创建密钥,或轮换已有密钥。
  2. 复制密钥对,保存在安全位置。

2. 请求签名与鉴权

所有管理 API 请求都必须携带基于 AK/SK 的数字签名。签名过程概述如下:

  1. 构造请求基础信息(方法、URL、查询参数、请求体)。
  2. 计算 Content-Digest 头部,确保请求体未被篡改。
  3. 组合签名组件并生成 Signature-Input,包含 keyidcreatednonce 等字段。
  4. 使用 Secret Key 对签名基串执行 HMAC-SHA256,生成 Signature 头部。
  5. 将签名后的请求发送给 magik-openapi,等待服务端验证。

详细签名步骤与示例可参考 [docs/integration/request.md](https://docs.magikcloud.cn/integration/request/)