diff --git a/docs/api_downapp.md b/docs/api_downapp.md index 2305968..a487aef 100644 --- a/docs/api_downapp.md +++ b/docs/api_downapp.md @@ -3,25 +3,21 @@ ## 概述 本文档说明下游应用如何调用 `reallife_asset` 模块接口,完成真人人像素材的认证、上传及状态查询。 +**baseurl**: +https://token.opencomputing.cn + **认证机制**: -- 所有接口通过 **dapi Bearer Token** 认证:客户端在请求头中携带 `Authorization: Bearer ` -- dapi 中间件自动识别调用方身份,设置 `get_user()`(用户ID)和 `get_userorgid()`(机构ID) -- **调用方无需传递身份参数**,系统自动从认证上下文中获取 +- 所有接口通过 **Bearer Token** 认证:客户端在请求头中携带 `Authorization: Bearer ` **素材上传**: -- `source_url` 支持两种格式:公网 URL 或 `data:` base64 编码 -- base64 格式由系统通过 `b64media2url` 自动转为公网地址,无需客户自行托管文件 - -**供应商密钥管理**: -- 供应商密钥(AK/SK)由营运人员在后台集中维护,调用方无需在请求中传递。 +- `source_url` 支持两种格式:公网 URL 或 `data:` base64 编码, 或用formdata上传文件 ## 业务流程 -1. **人工配置**:营运人员在 `rl_vendor_config` 表中登记供应商的全局 AK/SK 并激活状态。 -2. **真人认证**:调用方发起认证请求 (`rl_verify`),获取 H5 链接供终端用户完成人脸识别。 -3. **自动映射**:认证成功后,系统自动登记该机构 (`org_id`) 与供应商组合 ID (`vendor_group_id`) 的映射关系到 `rl_org_group` 表。 -4. **上传素材**:使用已认证的组合 ID 上传图片/视频,系统验证组合归属关系 (`rl_upload`)。 -5. **状态同步**:轮询检查素材处理状态 (`rl_status`)。 +1. **真人认证**:调用方发起认证请求 (`rl_verify`),获取 H5 链接供终端用户完成人脸识别。 +2. **查询已认证group_id**:查询当前机构下所有已认证的组合 ID,用于上传素材时选择有效的 group_id +3. **上传素材**:使用已认证的组合 ID 上传图片/视频,系统验证组合归属关系 (`rl_upload`)。 +4. **状态同步**:轮询检查素材处理状态 (`rl_status`)。 --- @@ -70,7 +66,39 @@ Content-Type: application/json --- -## 2. 上传素材 +## 2. 查询已认证的组合列表 +**Endpoint**: `/reallife_asset/api/rl_query_groups.dspy` + +查询当前机构下所有已认证的组合 ID,用于上传素材时选择有效的 `group_id`。 + +### 请求参数 +无需参数,系统自动从 Bearer Token 获取 `org_id`。 + +### 请求示例 +```http +POST /reallife_asset/api/rl_query_groups.dspy +Authorization: Bearer +``` + +### 返回示例 +**成功**: +```json +{ + "success": true, + "groups": [ + { + "vendor_group_id": "volc-asset-group-xxx", + "vendor": "volcengine", + "status": "active", + "create_time": "2026-05-28 15:30:00" + } + ] +} +``` + +--- + +## 3. 上传素材 **Endpoint**: `/reallife_asset/api/rl_upload.dspy` 向已认证的素材组合上传图片或视频素材。 @@ -128,7 +156,7 @@ Content-Type: application/json --- -## 3. 查询素材状态 +## 4. 查询素材状态 **Endpoint**: `/reallife_asset/api/rl_status.dspy` 查询素材的处理状态(Processing / Active / Failed)。 @@ -165,37 +193,6 @@ Content-Type: application/json --- -## 4. 查询已认证的组合列表 -**Endpoint**: `/reallife_asset/api/rl_query_groups.dspy` - -查询当前机构下所有已认证的组合 ID,用于上传素材时选择有效的 `group_id`。 - -### 请求参数 -无需参数,系统自动从 Bearer Token 获取 `org_id`。 - -### 请求示例 -```http -POST /reallife_asset/api/rl_query_groups.dspy -Authorization: Bearer -``` - -### 返回示例 -**成功**: -```json -{ - "success": true, - "groups": [ - { - "vendor_group_id": "volc-asset-group-xxx", - "vendor": "volcengine", - "status": "active", - "create_time": "2026-05-28 15:30:00" - } - ] -} -``` - ---- ## 5. 认证回调(供应商调用) **Endpoint**: `/reallife_asset/api/rl_callback.dspy`