Skip to main content
AltoPocket
开发者

AltoPocket 集成 API

面向已获批合作伙伴平台的服务器间集成。每个请求都用您的密钥签名;获批密钥可以做什么,将在获批后于开发者控制台中显示。

使用方式

仅限已获批的合作伙伴

填写公司、联系人和服务器 IP 进行申请。AltoPocket 运营人员会审核每一份申请。

功能在获批后提供

获批后,可在开发者控制台查看此密钥可获授予的权限,并附上理由申请所需权限。

签名的服务器间调用

每次调用都带有密钥和 HMAC 签名,且仅接受白名单中的服务器 IP。

涉及价值转移的操作不会自动执行:由 AltoPocket 运营人员批准。

请求如何签名

每个请求都需携带 API 密钥(x-api-key)、Unix 时间戳(X-AP-Timestamp,±5 分钟内)以及 X-AP-Signature:用签名密钥对时间戳、HTTP 方法、含查询字符串的路径和原始请求体字节的 SHA-256 以换行连接后计算 HMAC-SHA256。每个 POST 还需携带 Idempotency-Key。仅接受来自白名单服务器 IP 的调用。

Swagger 参考可以在浏览器中为 "Try it out" 请求签名。请仅在其中使用沙盒密钥——切勿将正式环境的签名密钥粘贴到浏览器。

公开文档仅包含签名方法、连通性检查和申请。获批的合作伙伴可查看与其权限对应的完整文档:在 Swagger 页面输入沙盒密钥并选择“Unlock full docs”,或从服务器获取 GET /integrations/v1/docs/openapi.json(需签名)。

通过 Swagger 测试

Try it out 在浏览器中为每个请求签名,因此请求来自浏览器的公网 IP,该 IP 必须被您的密钥允许:您的生产服务器 IP、沙盒测试人员 IP,或 AltoPocket 运营人员可为您的客户端开启的沙盒“允许任意 IP”设置之一。签名面板中的“Check my IP”会显示 API 看到的 IP,被拒绝的调用会告诉您被拒绝的 IP。切勿将正式环境的签名密钥粘贴到浏览器中。

canonical = timestamp + "\n"
          + METHOD + "\n"
          + path_with_query + "\n"
          + hex(sha256(raw_body))

X-AP-Signature = hex(hmac_sha256(secret, canonical))
x-api-key      = apk_…
X-AP-Timestamp = unix seconds (±300 s)
Idempotency-Key = <every POST>

环境

沙盒

测试网络(TRON Nile)与测试数据。此处签发的密钥以 apk_dev_ 或 apk_stage_ 开头。

  • https://api.devkcw.com/api/v1/integrations/v1

正式

生产环境。密钥以 apk_live_ 开头,与沙盒密钥分开签发。

https://api.altopocket.com/api/v1/integrations/v1

权限在获批后申请

申请时不请求任何权限。密钥获批并领取后,可在开发者控制台(或用密钥签名调用 GET /integrations/v1/scopes)查看每项权限允许的操作,并附上理由申请所需权限。每次申请均由运营人员审核。

打开开发者控制台

申请 API 密钥

无需账户。请告诉我们贵公司信息、将调用我们的服务器 IP 以及要构建的内容。申请时不请求任何权限:获批后,使用状态令牌领取一次密钥,然后用该密钥在开发者控制台申请所需权限。AltoPocket 运营人员会审核每一份申请和每一次权限申请。

国际格式(+国家代码…),或在左侧填写国家代码后输入本国号码。加密存储。

仅限 443 端口的 https 与公网主机。

公网 IP 或不宽于 /24 的 IPv4 网段,每行一个,最多 20 个。

在浏览器中签名的 Swagger“Try it out”调用来自您的电脑,因此其公网 IP 必须被允许。仅在沙盒(dev/stage)中使用,正式环境会拒绝。规则与服务器 IP 相同,最多 10 个。

此处无需选择权限。获批后,请用密钥在开发者控制台申请。

至少 20 个字符。

每份申请都由 AltoPocket 运营人员审核。

开发者 — 集成 API · AltoPocket