Skip to content

API 快速开始

当调用方是后台系统并且通过 API 链路接入时,使用这条路径。

典型顺序

  1. 申请 API key 和 secret
  2. 确认 key 具备的 scope
  3. 使用 HMAC 对请求签名
  4. 只调用 /api/v1/** 端点
  5. 显式处理 scope 和权限失败

必读概念

  1. Web 链路与 API 链路
  2. 认证模型
  3. 权限与 Scope
  4. 错误模型

最重要的规则

并不是所有文档里的接口都支持 API key 访问。只有明确暴露在 API 链路上的 endpoint 才能这样调用。

常见 403 原因

  1. 实际调用的是 /web/v1/**,不是 /api/v1/**
  2. 该 endpoint 根本不对 API 链路开放
  3. API key 缺少所需 scope
  4. 签名、时间戳或 nonce 处理错误

内部文档