K2 API 是完整的 RESTful API。该 API 架构于完整的 REST 资源模型。每个资源都有一个 URI(统一资源标识符),操作取决于 HTTP 请求方法(GET / POST / PATCH 等)。
每个操作的结果均由标准 HTTP 响应代码(即 200 - 成功,403 - 禁止等)清楚定义。
MG+ K2 通用钱包 API 方法文件
如需参考详细和最新的 K2 API 方法文件请由以下网址进入 K2 开发人员网站 (DevPortal : https://devportal.k2net.io/ ).
此文件会对 IP 白名单做限制, 如需存取请与您的客户经理联系将您的 IP 地址列入白名单。
K2 API 存取
节点
每次访问 K2 API,客户端都会从 MG +接收一个专用的 URL 地址。
该地址在本文档中标记为 <API-HOST>。而 K2 API 的访问协议是经由 HTTPS。
端点地址的架构如下: https://<API-HOST>/api/
这份文件的 API 版本为: 1
认证与授权
透过从 STS 接收到的有效访问令牌来完成 K2 API 的身份验证和授权。
令牌应按以下格式作为请求标头:
Authorization: Bearer <token>
提交请求参数
K2 API 方法使用两个范本来发布数据:
|
类型 |
|
备注 |
|---|---|---|
|
Forms |
application/x-www-formurlencoded |
所有默认接受key/value对参数的方法。这是预设格式。 |
|
JSON |
application/json |
所有接受输入参数作为对象的方法。 |