API 参考
API 参考
首批经过审核的公开 API 操作目录。
当前目录包含 64 个由 API CI 明确发布的 public-only 操作。目录、认证与 schema 仅来自同一 artifact；未列出的路由均视为私有。
- API 来源提交:
fea64ddee8d29d0f9296de5b046cb26ce0a96cdf - OpenAPI SHA-256:
989e09de11d6a1accdf647db33b9b1dc24141458771dc4a69bc99ca8c083c2f0 - OpenAPI:
3.1.0
Storefront 公开读取（14）
GET /api/v1/bootstrap— 读取公开站点启动配置GET /api/v1/catalog/categories— 读取公开分类GET /api/v1/catalog/merchants/{merchantSlug}/products/{productSlug}— 读取店铺公开商品详情GET /api/v1/catalog/merchants/{slug}/categories— 读取店铺公开分类GET /api/v1/catalog/merchants/{slug}/products— 读取店铺公开商品GET /api/v1/catalog/merchants/{slug}— 读取公开店铺资料GET /api/v1/catalog/products/{slug}— 按 slug 读取公开商品GET /api/v1/catalog/products— 读取公开商品目录GET /api/v1/legal/documents— 按语言读取当前已发布法律正文GET /api/v1/public/contact— 读取公开联系渠道GET /api/v1/public/store-access/{store}/config— 读取店铺公开安全配置GET /api/v1/runtime-config— 读取公开运行配置GET /api/v1/search— 搜索可公开销售商品GET /api/v1/storefront-decorations/merchants/{slug}— 读取店铺已发布装修
官方账号与挑战端点（5）
POST /api/v1/auth/password/reset/confirm— 在官方认证域执行密码重置POST /api/v1/auth/password/reset/request— 在官方认证域请求密码重置POST /api/v1/auth/register— 在官方认证域注册客户POST /api/v1/public/store-access/{store}/challenges/verify— 由 API 向 Cloudflare 验证并单次消费挑战POST /api/v1/public/store-access/{store}/challenges— 创建绑定店铺与精确 Origin 的风险挑战
Installation 身份与 readiness（2）
GET /api/v1/open/installation/identity— 读取安装级凭据绑定身份GET /api/v1/open/installation/readiness— 读取安装级凭据就绪与阻塞事实
Hosted session 与官方浏览器流程（10）
POST /api/v1/hosted/checkout/{sessionId}/cancel— 安全取消尚未进入不可逆阶段的官方托管结账POST /api/v1/hosted/checkout/{sessionId}/projection— 读取官方托管结账安全摘要POST /api/v1/hosted/checkout/{sessionId}/return— 读取已批准的精确回跳地址与原始 statePOST /api/v1/hosted/checkout/{sessionId}/ticket— 单次消费官方托管结账票据并读取安全摘要POST /api/v1/hosted/login/{flowId}/ticket— 单次消费官方托管登录票据并读取请求方投影POST /api/v1/open/hosted/checkout/sessions/{sessionId}/cancel— 取消尚未进入不可逆支付阶段的托管结账GET /api/v1/open/hosted/checkout/sessions/{sessionId}— 读取绑定安装的托管结账状态POST /api/v1/open/hosted/checkout/sessions— 创建服务端重算的托管结账会话POST /api/v1/open/hosted/login/initiate— 创建官方托管登录流程POST /api/v1/open/hosted/login/return— 以 PKCE 单次消费托管登录返回码
API Key 目录读取（4）
GET /api/v1/open/catalog/categories— 通过 API Key 读取公开分类GET /api/v1/open/catalog/products/{slug}— 通过 API Key 读取公开商品GET /api/v1/open/catalog/products— 通过 API Key 读取公开商品目录GET /api/v1/open/identity— 读取当前 API Key 的标识与 scope
Storefront 购物车与报价（13）
PUT /api/v1/open/storefront/carts/{cartId}/address— 校验并保存购物车短期地址令牌GET /api/v1/open/storefront/carts/{cartId}/checkout-quote— 生成配送税费优惠统一结算报价POST /api/v1/open/storefront/carts/{cartId}/checkout— 由购物车创建官方托管结账会话POST /api/v1/open/storefront/carts/{cartId}/clear— 清空公开购物车DELETE /api/v1/open/storefront/carts/{cartId}/items/{skuId}— 移除公开购物车 SKUPATCH /api/v1/open/storefront/carts/{cartId}/items/{skuId}— 更新公开购物车 SKU 数量POST /api/v1/open/storefront/carts/{cartId}/items— 向公开购物车添加 SKUDELETE /api/v1/open/storefront/carts/{cartId}/promotion— 移除购物车优惠码PUT /api/v1/open/storefront/carts/{cartId}/promotion— 校验并应用购物车优惠码POST /api/v1/open/storefront/carts/{cartId}/quote— 按实时价格与库存生成短期报价POST /api/v1/open/storefront/carts/{cartId}/revoke— 撤销公开购物车访问票据GET /api/v1/open/storefront/carts/{cartId}— 读取安装绑定的公开购物车POST /api/v1/open/storefront/carts— 创建安装绑定的公开购物车
Storefront 订单与售后（6）
GET /api/v1/open/storefront/orders/{orderId}/after-sales-eligibility— 读取退款退货售后资格POST /api/v1/open/storefront/orders/{orderId}/after-sales— 提交退款或进入官方售后流程GET /api/v1/open/storefront/orders/{orderId}/cancellation-eligibility— 读取订单取消资格POST /api/v1/open/storefront/orders/{orderId}/cancellations— cancelStorefrontOrderGET /api/v1/open/storefront/orders/{orderId}— 读取 receipt 绑定的最小订单状态GET /api/v1/open/storefront/orders— 以 customer-bound receipt proof 读取最小订单列表
Installation Webhook（7）
POST /api/v1/open/webhooks/deliveries/{id}/replay— 幂等重放 dead 或 retrying 投递GET /api/v1/open/webhooks/deliveries— 读取安装绑定的最小投递状态GET /api/v1/open/webhooks/endpoints/{id}/signature-fixture— 读取无 PII 的签名校验 fixturePATCH /api/v1/open/webhooks/endpoints/{id}— 更新或停用安装绑定的 Webhook 订阅GET /api/v1/open/webhooks/endpoints— 读取安装绑定的 Webhook 订阅POST /api/v1/open/webhooks/endpoints— 创建安装绑定的 Webhook 订阅GET /api/v1/open/webhooks/events— 读取安装获准的 Webhook 事件类型
OAuth PKCE 与 DPoP（3）
GET /api/v1/oauth/authorize— 读取官方授权确认事实POST /api/v1/oauth/revoke— 撤销当前 DPoP token familyPOST /api/v1/oauth/token— 以 PKCE 或轮换 refresh token 交换 DPoP token
公开边界
当前 artifact 已包含 OAuth PKCE/DPoP、installation Webhook、购物车报价以及订单读取/取消/售后操作。订单最终创建、支付执行与退款专用操作未在本 artifact 中声明；托管结账 complete/continue 绑定官方 session 与 CSRF，也不属于第三方公开 API。本站不为这些能力制造路径或示例。
权威阻塞原因
以下状态来自同一 public-only artifact，只解释能力为何尚未开放，不表示 endpoint 已存在。
| 能力 | 当前阻塞 |
|---|---|
| Installation 写入 API | 仍需 sender-constrained installation credential |
| 订单最终创建 | 仍需经过审核的公开订单最终创建契约 |
| 生产启用 | 外部 readiness 尚未获得证明 |