API 參考總覽

所有開發者 API 資源的索引與共用規則。

檢視 Markdown

路徑規則是 /api/{資源}[/{資源Id}][/{動作}](例如 /api/PaymentLink、/api/Subscription/{subscriptionId}/Cancel),用 Authorization: Bearer <API Key> 驗證。成功回應是 { data },列表另外帶 page、pageSize、totalCount、totalPages;失敗回應是 { error: { code, message } }。列表用 page(從 1 開始)、pageSize(預設 20,最大 200)、orderBy、orderDirection(ASC/DESC)、createdFrom、createdTo 查詢。欄位一律 camelCase,列舉值用 PascalCase(例如 Active、PastDue)。完整、機器可讀的規格在 GET /api/OpenApi?audience=developer。

資源