API 参考

身份验证

API 密钥请求头、密钥保管、权限和轮换。

凭据模型

MakePay API 密钥从 MakeCrypto 开发者区域创建,并限定到一个团队。每个密钥都有公开 key ID 和 secret。secret 会以哈希形式存储,并且只在创建后显示一次。

请求头说明
x-makecrypto-key-idMakePay API 密钥 IDMakePay 支付 API 使用 mk_makepay_ 前缀。
x-makecrypto-key-secret一次性 API 密钥只会在创建密钥时显示。请保存在服务器端密钥管理器中。

创建 API 密钥

拥有 settings.manage 权限的已登录用户,可以通过门户或团队集成路由创建密钥。

当门户工具需要展示当前用户可用团队时,使用已登录公司的发现路由:

GET /api/partner/v1/companies

返回的公司 id 仅用于仪表盘和密钥管理路由。MakePay 服务器到服务器支付路由会从 API 密钥解析公司,因此 URL 中不需要公司 ID。

POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json
{
  "name": "Production backend",
  "appSlug": "makepay",
  "allowedOrigins": ["https://merchant.example"]
}

响应包含 integration.key_idintegration.partner_idintegration.keySecret。请立即保存 keySecret

请求身份验证

向 MakePay 支付链接路由发送 key ID 和 secret 请求头。

x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...

门户 UI 调用也可以使用已登录的 MakeCrypto 浏览器会话。服务器到服务器集成应使用密钥请求头,让请求不依赖用户会话。

权限

读取路由接受任何已登录团队成员或有效 MakePay API 密钥。浏览器会话调用变更路由时需要 settings.manage。API 密钥会被视为所属团队的可信服务器凭据,因此只应放在你控制的后端系统中。

轮换和撤销

创建新密钥,将它部署到后端,然后在 MakeCrypto 开发者区域禁用或删除旧密钥。创建后无法再次查看既有 secret。

身份验证错误

  • 401 Unauthorized 表示请求没有有效会话,也没有有效 API key 组合。
  • 401 Invalid MakePay API credentials 表示 key ID、secret、产品范围或启用状态不匹配。
  • 403 Forbidden 表示已登录用户无法访问团队或缺少所需权限。
  • 404 API key not found 是密钥管理路由在所选 partnerId 不属于该团队时返回的错误。

需要合作伙伴设置帮助?

在 MakeCrypto 中打开支付链接详情,复制真实支付 UID 的生成代码片段;也可以返回门户管理商户设置。

打开门户