upi-checkout-link API 文档

面向结账工作台、任务系统和支付接入的当前实例合同。接口路径、参数、响应和访问范围直接来自正在运行的 Go handler，不维护第二份手写路由清单。

48 个接口 11 个功能分组 OpenAPI 3.1.0 响应格式 JSON

快速开始

先读取运行配置，再按 CDK 创建或查询任务；异步接口的 202 只表示已受理。

读取 /api/config，确认 Provider、批量上限和当前协议能力。
使用 /api/v1/cdk/status 校验 CDK，不把状态查询当作扣费结果。
创建任务后保存 workflow ID 和客户端动作 ID，通过 SSE cursor 或查询接口续传。
只有明确终态才停止轮询；支付回调、支付结果和 Plus 到账分别判断。

BASE_URL="https://your-checkout-host"

curl "$BASE_URL/api/health"
curl "$BASE_URL/api/config"

curl -X POST "$BASE_URL/api/v1/cdk/status" \
  -H "Content-Type: application/json" \
  --data '{"cdk":"<CHECKOUT_CDK>"}'

系统状态

进程存活、角色就绪和接单状态。

2 个接口

GET/api/health查询进程存活状态公开

OPERATION IDgetLiveness

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	进程可响应

GET/api/ready查询当前角色接单状态公开

OPERATION IDgetReadiness

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	当前角色可以接单
`503`	当前角色未就绪或正在摘流

运行配置

Provider、协议能力和版本化运行策略。

1 个接口

GET/api/config查询版本化运行配置公开

OPERATION IDgetRuntimeConfig

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-Checkout-Config-Schema`	header	`integer`	否	客户端支持的配置 schema 版本

响应

HTTP	说明
`200`	运行配置
`426`	客户端配置 schema 版本过旧
`500`	运行配置生成失败

容量与限流

全局并发、CDK 并发、速率和队列容量。

1 个接口

POST/api/capacity查询全局和分维度容量公开

OPERATION IDgetCapacity

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	容量快照
`400`	请求参数不正确
`503`	容量数据暂时不可用

统计分析

提炼结果和时间桶统计投影。

1 个接口

GET/api/link-success-stats查询提炼成功率时间桶公开

OPERATION IDgetLinkSuccessStats

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`hours`	query	`integer`	否	统计窗口小时数
`bucket_minutes`	query	`integer`	否	时间桶分钟数
`provider`	query	`string`	否	支付 Provider
`rail`	query	`string`	否	Checkout rail
`stage`	query	`string`	否	流程阶段

响应

HTTP	说明
`200`	成功率时间桶
`400`	统计窗口参数不正确
`503`	成功率统计暂时不可用

CDK 与计费

CDK 状态、融合、账本和对账控制面。

4 个接口

POST/api/v1/cdk/status查询 CDK 状态公开

OPERATION IDgetCdkStatus

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	CDK 状态
`400`	CDK 查询参数不正确
`402`	CDK 可用点数不足
`403`	CDK 或渠道不可用
`404`	CDK 不存在
`429`	CDK 服务限流
`502`	CDK 上游服务不可用或响应无效
`504`	CDK 上游查询超时

POST/api/v1/cdk/fuse提交可续传 CDK 融合操作公开

OPERATION IDfuseCdks

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`Idempotency-Key`	header	`string`	否	客户端动作键；服务端另以融合组合 hash 保证计费幂等
`X-Client-Action-ID`	header	`string`	否	刷新和断流恢复使用的客户端动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	上游已存在相同融合结果
`201`	融合完成并持久化结果
`400`	融合输入或上游业务条件不正确
`409`	客户端动作冲突
`429`	CDK 融合服务限流
`502`	CDK 融合上游不可用或响应无效
`503`	融合配置或 operation 存储不可用
`504`	CDK 融合上游超时

GET/api/v1/cdk/fusions/by-client-action/{client_action_id}按目标 CDK 查询融合 operation 和结果公开

OPERATION IDgetCdkFusionByClientAction

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`client_action_id`	path	`string`	是	原融合请求的客户端动作 ID
`X-UPI-CDK`	header	`string`	是	原融合目标 CDK；仅用于匹配脱敏 actor identity

响应

HTTP	说明
`200`	融合 operation 和已持久化响应
`404`	目标 CDK 不匹配或 operation 不存在
`503`	operation 存储暂时不可用

GET/api/v2/billing/ledger查询当前 CDK 隔离的额度流水和关联任务公开

OPERATION IDgetCdkBillingLedger

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`email`	query	`string`	否	完整账号邮箱，不区分大小写
`status`	query	`string`	否	流水状态：all、reserve、commit、release、refund
`from`	query	`string`	否	RFC3339 起始时间，包含
`to`	query	`string`	否	RFC3339 结束时间，不包含
`cursor`	query	`string`	否	上一页返回的 ledger ID 游标
`limit`	query	`integer`	否	每页 1–500 条

响应

HTTP	说明
`200`	当前 CDK 的额度流水、汇总和下一页游标
`400`	CDK 或查询条件不正确
`503`	额度明细数据库暂时不可用

兼容接口

旧客户端薄适配器；新接入优先使用版本化接口。

4 个接口

POST/api/cdk-status兼容查询 CDK 状态公开已弃用

OPERATION IDlegacyGetCdkStatus

鉴权无需凭据

响应类型application/json

推荐替代接口：/api/v1/cdk/status

参数

此接口没有已登记的 path、query 或 header 参数。

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	兼容 CDK 状态
`400`	CDK 查询参数不正确
`402`	CDK 可用点数不足
`403`	CDK 或渠道不可用
`404`	CDK 不存在
`429`	CDK 服务限流
`502`	CDK 上游服务不可用或响应无效
`504`	CDK 上游查询超时

POST/api/cdk-fuse兼容提交 CDK 融合操作公开已弃用

OPERATION IDlegacyFuseCdks

鉴权无需凭据

响应类型application/json

推荐替代接口：/api/v1/cdk/fuse

参数

此接口没有已登记的 path、query 或 header 参数。

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	兼容融合结果
`201`	兼容融合完成结果
`400`	融合输入或上游业务条件不正确
`409`	客户端动作冲突
`429`	CDK 融合服务限流
`502`	CDK 融合上游不可用或响应无效
`503`	融合配置或 operation 存储不可用
`504`	CDK 融合上游超时

POST/api/payment-platform/balance兼容查询发布平台余额公开已弃用

OPERATION IDlegacyGetPublisherBalance

鉴权无需凭据

响应类型application/json

推荐替代接口：/api/v1/publishers/{publisher_id}/balance

参数

此接口没有已登记的 path、query 或 header 参数。

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	兼容余额结果
`400`	平台或凭据参数不正确
`404`	平台未启用
`502`	发布平台暂时不可用

GET/api/payment-platform/masi/teams兼容查询 Masi 团队公开已弃用

OPERATION IDlegacyGetMasiTeams

鉴权无需凭据

响应类型application/json

推荐替代接口：/api/v1/publishers/masi/options

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	兼容 Masi 团队列表
`404`	Masi 未启用
`502`	Masi 暂时不可用

账号池

账号导入、批次、错误报告和提炼派发。

12 个接口

GET/api/v1/at-pools/batches分页查询账号批次和导入进度公开

OPERATION IDlistAccountPoolBatches

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	批次所属 CDK
`cursor`	query	`string`	否	上一页返回的 opaque 批次游标
`before_batch_no`	query	`integer`	否	旧版批次编号游标
`limit`	query	`integer`	否	每页 1-500 个批次

响应

HTTP	说明
`200`	批次、服务端总数、下一页游标和 operation 进度
`400`	CDK 或分页参数不正确
`503`	批次状态暂时不可用

GET/api/v1/at-pools/batches/{batch_id}查询单个账号批次和导入进度公开

OPERATION IDgetAccountPoolBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`batch_id`	path	`string`	是	持久化批次 ID
`X-UPI-CDK`	header	`string`	是	批次所属 CDK

响应

HTTP	说明
`200`	批次、operation 和精确导入进度
`400`	CDK 不正确
`404`	批次不存在或 CDK 不匹配
`503`	批次状态暂时不可用

DELETE/api/v1/at-pools/batches/{batch_id}提交可续传的账号批次删除操作公开

OPERATION IDdeleteAccountPoolBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`batch_id`	path	`string`	是	持久化批次 ID
`X-UPI-CDK`	header	`string`	是	批次所属 CDK
`Idempotency-Key`	header	`string`	是	批次删除幂等键
`X-Client-Action-ID`	header	`string`	是	刷新后续传删除操作

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`202`	删除任务已持久化受理
`400`	参数不正确
`404`	批次不存在或 CDK 不匹配
`409`	批次仍有活动任务或操作冲突
`503`	删除服务暂时不可用

GET/api/v1/at-pools/batches/{batch_id}/accounts按 keyset 分页查询批次账号展示状态公开

OPERATION IDlistAtBatchAccounts

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`batch_id`	path	`string`	是	持久化批次 ID
`X-UPI-CDK`	header	`string`	是	批次所属 CDK
`cursor`	query	`integer`	否	上一页 next_cursor；账号 ID keyset
`after_account_id`	query	`integer`	否	旧版账号 ID keyset
`limit`	query	`integer`	否	每页 1-500 个账号

响应

HTTP	说明
`200`	脱敏账号、完整总数、has_more 和下一页游标
`400`	CDK 或分页参数不正确
`404`	批次不存在或 CDK 不匹配
`503`	批次账号暂时不可读取

POST/api/v1/at-pools/start原子受理批次目标数并分块生成提炼任务公开

OPERATION IDstartAccountPoolBatch

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`Idempotency-Key`	header	`string`	是	启动操作幂等键
`X-Client-Action-ID`	header	`string`	是	刷新后续传启动操作

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`202`	目标数已原子记录并开始后台 materialize
`400`	启动参数不正确
`404`	批次不存在
`409`	批次状态不允许启动
`503`	启动服务暂时不可用

GET/api/v1/at-pools/runs/{run_id}查询批次目标数和 materialize 精确进度公开

OPERATION IDgetAccountPoolBatchRun

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`run_id`	path	`string`	是	批次运行 ID
`X-UPI-CDK`	header	`string`	是	运行所属 CDK

响应

HTTP	说明
`200`	目标数、已生成数和拒绝数
`404`	运行不存在或 CDK 不匹配
`503`	运行状态暂时不可用

GET/api/v1/at-pools/batch-deletions/{delete_id}查询分块删除进度公开

OPERATION IDgetAccountPoolBatchDeletion

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`delete_id`	path	`string`	是	删除操作 ID
`X-UPI-CDK`	header	`string`	是	批次所属 CDK

响应

HTTP	说明
`200`	删除阶段和精确计数
`404`	删除操作不存在或 CDK 不匹配
`503`	删除状态暂时不可用

POST/api/v1/at-pools/import-paste提交可续传账号导入任务公开

OPERATION IDimportAccountPoolPaste

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`Idempotency-Key`	header	`string`	是	同一输入重放时返回原导入操作
`X-Client-Action-ID`	header	`string`	是	浏览器断线续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`201`	已完成的原导入结果重放
`202`	导入任务已持久化受理
`400`	导入参数不正确
`409`	幂等键或动作 ID 冲突
`503`	导入服务暂时不可用

GET/api/v1/at-pools/imports/{import_id}查询账号导入进度公开

OPERATION IDgetAccountPoolImport

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`import_id`	path	`string`	是	持久化导入 ID
`X-UPI-CDK`	header	`string`	是	导入所属 CDK

响应

HTTP	说明
`200`	导入状态、checkpoint 和精确计数
`404`	导入不存在或 CDK 不匹配
`503`	导入状态暂时不可用

GET/api/v1/at-pools/import-errors/{import_id}查询或下载稳定错误码报告公开

OPERATION IDgetAccountPoolImportErrors

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`import_id`	path	`string`	是	持久化导入 ID
`X-UPI-CDK`	header	`string`	是	导入所属 CDK
`after_row`	query	`integer`	否	错误行 keyset 游标
`limit`	query	`integer`	否	每页 1-5000 行
`format`	query	`string`	否	json 或 csv

响应

HTTP	说明
`200`	错误总数和报告行
`400`	游标参数不正确
`404`	导入不存在或 CDK 不匹配
`503`	错误报告暂时不可用

POST/api/v1/at-pools/import-errors/{import_id}/replay按原 parser version 重放失败行公开

OPERATION IDreplayAccountPoolImportErrors

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`import_id`	path	`string`	是	原导入 ID
`Idempotency-Key`	header	`string`	是	失败行重放幂等键
`X-Client-Action-ID`	header	`string`	是	刷新后续传重放导入

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`201`	失败行重放完成
`202`	失败行重放已受理
`404`	原导入不存在
`409`	parser version 或幂等输入冲突
`503`	重放服务暂时不可用

GET/api/v1/at-pools/imports/by-client-action/{client_action_id}按客户端动作续传账号导入公开

OPERATION IDgetAccountPoolImportByClientAction

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`client_action_id`	path	`string`	是	浏览器持久化的动作 ID
`X-UPI-CDK`	header	`string`	是	导入所属 CDK

响应

HTTP	说明
`200`	原 operation、响应和导入进度
`404`	导入不存在或 CDK 不匹配
`503`	导入状态暂时不可用

任务工作流

持久化任务、生命周期、进度和事件流。

17 个接口

POST/api/v2/workflows原子创建单个持久化任务公开

OPERATION IDcreateWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`201`	workflow 和首个 work 已原子创建
`400`	参数不正确
`409`	幂等输入冲突
`503`	任务服务或 CDK 服务不可用

GET/api/v2/workflows按 keyset 分页查询任务投影公开

OPERATION IDlistWorkflows

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`cursor`	query	`string`	否	上一页 opaque 游标
`limit`	query	`integer`	否	每页 1-500 个任务
`state`	query	`string`	否	任务状态筛选
`provider_id`	query	`string`	否	Provider 筛选
`batch_id`	query	`string`	否	批次筛选

响应

HTTP	说明
`200`	精确总数、as_of_cursor 和任务投影
`400`	分页参数不正确
`503`	任务状态服务暂时不可用

GET/api/v2/workflows/history按 CDK 精确聚合历史任务统计公开

OPERATION IDgetWorkflowHistory

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`range`	query	`string`	否	时间范围：1h、6h、24h、7d、30d、today、yesterday
`provider_id`	query	`string`	否	Provider 筛选
`billing_status`	query	`string`	否	账单状态：with_billing、without_billing、unknown
`ignore_error`	query	`string`	否	不计入失败 KPI 的原始错误码，可重复传入
`success_cursor`	query	`string`	否	成功记录上一页 opaque 游标
`success_limit`	query	`integer`	否	每页 1-500 条成功记录

响应

HTTP	说明
`200`	精确统计、趋势、原始失败分布和 as_of_cursor
`400`	历史查询参数不正确
`503`	任务历史服务暂时不可用

GET/api/v2/workflow-operations/by-client-action/{client_action_id}按 CDK 和客户端动作恢复原任务操作公开

OPERATION IDgetWorkflowOperationByClientAction

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`client_action_id`	path	`string`	是	客户端生成并在重试时保持不变的动作 ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`command_type`	query	`string`	否	workflow.* 稳定命令类型

响应

HTTP	说明
`200`	原 operation 和持久化响应
`400`	命令类型或 CDK 不正确
`404`	操作不存在
`503`	任务状态服务暂时不可用

GET/api/v2/workflows/{workflow_id}查询单任务及独立维度状态公开

OPERATION IDgetWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK

响应

HTTP	说明
`200`	workflow、维度、work、attempt 和 artifact 投影
`404`	任务不存在或已清除
`503`	任务状态服务暂时不可用

GET/api/v2/workflow-timelines/{workflow_id}按 cursor 分页查询任务公开时间线公开

OPERATION IDgetWorkflowTimeline

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`after`	query	`integer`	否	已读取的最后事件 cursor
`limit`	query	`integer`	否	每页 1-500 条事件

响应

HTTP	说明
`200`	不含内部快照和私密详情的公开事件时间线
`400`	分页参数不正确
`404`	任务不存在
`503`	任务时间线暂时不可用

POST/api/v2/workflows/batches快速受理并后台分块创建任务公开

OPERATION IDcreateWorkflowBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`202`	完整 target_count 已持久化
`400`	批次参数不正确
`409`	幂等输入冲突
`503`	任务服务或 CDK 服务不可用

GET/api/v2/workflows/batches/{batch_id}查询批量创建精确进度公开

OPERATION IDgetWorkflowBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`batch_id`	path	`string`	是	workflow batch ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK

响应

HTTP	说明
`200`	目标、已创建和失败计数
`404`	批次不存在
`503`	任务服务暂时不可用

POST/api/v2/workflows/{workflow_id}/pause请求任务在安全 checkpoint 暂停公开

OPERATION IDpauseWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	任务生命周期状态已持久化
`400`	参数不正确
`404`	任务不存在
`409`	状态或版本冲突
`503`	任务服务暂时不可用

POST/api/v2/workflows/{workflow_id}/resume从持久化 checkpoint 恢复任务公开

OPERATION IDresumeWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	任务生命周期状态已持久化
`400`	参数不正确
`404`	任务不存在
`409`	状态或版本冲突
`503`	任务服务暂时不可用

POST/api/v2/workflows/{workflow_id}/cancel请求任务取消并等待补偿完成公开

OPERATION IDcancelWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	任务生命周期状态已持久化
`400`	参数不正确
`404`	任务不存在
`409`	状态或版本冲突
`503`	任务服务暂时不可用

POST/api/v2/workflows/{workflow_id}/retry创建独立 retry attempt公开

OPERATION IDretryWorkflow

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`workflow_id`	path	`string`	是	持久化 workflow ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	任务生命周期状态已持久化
`400`	参数不正确
`404`	任务不存在
`409`	状态或版本冲突
`503`	任务服务暂时不可用

POST/api/v2/workflows/cancel/batch提交可续传批量取消操作公开

OPERATION IDcancelWorkflowBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`202`	批量取消 operation 已受理
`400`	参数不正确
`503`	任务服务暂时不可用

POST/api/v2/workflows/clear-unfinished按 cutoff 和 CAS 清除未完成任务公开

OPERATION IDclearUnfinishedWorkflows

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`Idempotency-Key`	header	`string`	是	命令幂等键
`X-Client-Action-ID`	header	`string`	是	浏览器刷新后续传动作 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`202`	tombstone operation 已受理
`400`	参数不正确
`503`	任务服务暂时不可用

GET/api/v2/workflows/lifecycle/{lifecycle_id}查询取消或清理 operation 进度公开

OPERATION IDgetWorkflowLifecycleOperation

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`lifecycle_id`	path	`string`	是	workflow lifecycle ID
`X-UPI-CDK`	header	`string`	是	任务所属 CDK

响应

HTTP	说明
`200`	operation 精确进度
`404`	operation 不存在
`503`	任务服务暂时不可用

GET/api/v2/workflows/events按单调 cursor 获取任务 SSE 事件公开

OPERATION IDstreamWorkflowEvents

鉴权CDK

响应类型text/event-stream

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK
`after`	query	`integer`	否	已消费的最后事件 cursor
`limit`	query	`integer`	否	单次最多 1000 个事件

响应

HTTP	说明
`200`	workflow 事件和下一 cursor
`400`	cursor 参数不正确
`503`	任务事件服务暂时不可用

POST/api/v2/workflows/progress/batch迁移期批量进度兼容接口公开

OPERATION IDgetWorkflowProgressBatch

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-UPI-CDK`	header	`string`	是	任务所属 CDK

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	最多 1000 个 workflow 投影
`400`	参数不正确
`503`	任务服务暂时不可用

前端同步

同版本配置、计数、批次和任务快照。

1 个接口

GET/api/v2/frontend/bootstrap读取同一前端快照中的配置、计数、批次和任务公开

OPERATION IDgetFrontendBootstrap

鉴权CDK

响应类型application/json

参数

名称	位置	类型	必填	说明
`X-Checkout-Projection-Schema`	header	`integer`	否	客户端支持的前端投影 schema 版本
`X-UPI-CDK`	header	`string`	否	可选；提供后返回该 CDK 的任务和账号批次快照

响应

HTTP	说明
`200`	同一 snapshot ID 下的首屏投影
`400`	CDK 不正确
`426`	前端投影 schema 不兼容
`503`	前端投影暂时不可用

支付平台

动态发布平台、余额和公开选项。

3 个接口

GET/api/v1/publishers查询动态发布平台和公开表单能力公开

OPERATION IDlistPublishers

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	已启用发布平台描述

POST/api/v1/publishers/{publisher_id}/balance查询指定发布平台余额公开

OPERATION IDgetPublisherBalance

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`publisher_id`	path	`string`	是	发布平台 ID

请求体

使用 application/json。具体字段、约束和示例以 OpenAPI 3.1 JSON 中该 operation 的 schema 为准。

响应

HTTP	说明
`200`	余额和可用状态
`400`	平台或凭据参数不正确
`404`	平台未启用或不支持余额查询
`502`	发布平台暂时不可用

GET/api/v1/publishers/{publisher_id}/options查询发布平台公开选项公开

OPERATION IDgetPublisherOptions

鉴权无需凭据

响应类型application/json

参数

名称	位置	类型	必填	说明
`publisher_id`	path	`string`	是	发布平台 ID

响应

HTTP	说明
`200`	版本化发布选项
`404`	平台未启用或不支持选项查询
`502`	发布平台暂时不可用

开发文档

当前实例的 HTML 与 OpenAPI 合同。

2 个接口

GET/api-docs查看中文 API 文档公开

OPERATION IDgetAPIDocumentation

鉴权无需凭据

响应类型text/html; charset=utf-8

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	中文 API 文档

GET/openapi.json下载当前实例 OpenAPI 合同公开

OPERATION IDgetOpenAPISpec

鉴权无需凭据

响应类型application/json

参数

此接口没有已登记的 path、query 或 header 参数。

响应

HTTP	说明
`200`	OpenAPI 3.1 JSON
`304`	合同未变化