API - 概览

API - 端点列表

查找端点、所需请求方法和权限,然后查看详细示例。

端点概览

下表对应 backend-public-api/app.js 中挂载的公共路由。所列路径包含供外部集成使用的公共代理前缀。

方法端点说明访问权限
GET/public-api/healthz服务健康检查。公开
GET/public-api/v1/auth/check验证凭据并返回店铺、权限范围和套餐功能。任何已验证身份的凭据
GET/public-api/v1/customer-orders返回可分页和筛选的客户订单列表。orders:read
GET/public-api/v1/customer-orders/:id返回包含已配置产品条目的单个客户订单。orders:read
POST/public-api/v1/customer-orders/batch按 ID 返回最多 100 个订单。orders:read
PATCH/public-api/v1/customer-orders/:id/status更新订单状态。orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity更新所选订单明细的数量。orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/all为订单中的每个条目设置相同数量。orders:write
DELETE/public-api/v1/customer-orders/:id删除属于店铺所有者的客户订单。orders:write
GET/public-api/v1/products返回店铺产品/设计,包含嵌入可用性和媒体 URL。products:read
GET/public-api/v1/products/:id返回一个店铺产品/设计。products:read
POST/public-api/v1/embed/session为嵌入式工具(包括模型生成器)签发短期有效的 JWT。embed:session:create
GET/public-api/v1/runtime/bootstrap根据嵌入 JWT 解析运行时上下文。Bearer 嵌入令牌
GET/public-api/v1/assets列出所请求类型的素材目录条目。任何已验证身份的凭据
GET/public-api/v1/assets/:type/:assetId返回包含可下载文件用途的素材清单。任何已验证身份的凭据
GET/public-api/v1/assets/:type/:assetId/files/:role按用途下载素材文件。任何已验证身份的凭据
GET/public-api/v1/design-imports列出托管在 Alter 上的可导入设计。已验证身份的凭据,需要 Business 套餐
GET/public-api/v1/design-imports/:id返回设计导入数据载荷和文件描述信息。已验证身份的凭据,需要 Business 套餐
GET/public-api/v1/design-imports/:id/files/:fileId从设计导入描述信息下载文件。已验证身份的凭据,需要 Business 套餐
GET/public-api/v1/file/public/products/:productId/:size返回公共产品预览。尺寸必须为 small.png、medium.png 或 big.png。公开
GET/public-api/v1/file/protected/:key按存储键返回受保护文件。签名 URL 或 files:read
GET/public-api/v1/fonts返回所有可用字体。公开
GET/public-api/v1/currencies返回所有货币。公开
POST/public-api/v1/runtime-bindings/sync-from-wordpress根据 WordPress 产品映射创建或更新运行时绑定。任何已验证身份的凭据
PATCH/public-api/v1/runtime-bindings/:id部分更新运行时绑定。任何已验证身份的凭据
POST/public-api/v1/runtime-bindings/:id/activate激活运行时绑定。任何已验证身份的凭据
POST/public-api/v1/runtime-bindings/:id/deactivate停用运行时绑定。任何已验证身份的凭据
POST/public-api/v1/wp-connect/exchange将 WordPress 自动连接交接代码交换为 API 凭据。一次性交接代码
GET/public-api/v1/model-generator/catalog列出可见的生成器商品、配置和模板修订版本。embed:session:create
GET/public-api/v1/model-generator/models列出可导入的模型,包含其固定的生成器源描述符。embed:session:create
GET/public-api/v1/model-generator/designer-catalog返回 Designer 使用的生成器模型目录。embed:session:create
GET/public-api/v1/model-generator/projects列出所有者的生成器项目以及全局可用的生成器项目。embed:session:create
GET/public-api/v1/model-generator/projects/:projectId返回项目的最新或指定修订版本、模板和文件清单。embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/revisions/:revision返回项目的最新或指定修订版本、模板和文件清单。embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId检查项目访问权限后下载其产物。embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template返回所选配置修订版本中有权访问的模板文档。embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import返回包含依赖文件的模板导入包。embed:session:create
GET/public-api/v1/model-generator/mannequins返回两个人体模型及其资源描述符。embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assets列出纹理库或背景库中的资源及其可导入文件。embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assets/:assetId返回单个纹理或背景资源及其可导入文件。embed:session:create
GET/public-api/v1/model-generator/public-files/:key下载获准访问的生成器依赖文件。embed:session:create