API 市场与申请
API 市场列出已经发布、可供发现的接口。申请 API 的目标是使指定应用获得接口使用资格,不是申请一个可线下交付的数据产品。
查找并评估 API
- 进入“数据服务 → API 市场”,按业务用途查找目标接口。
- 打开 API 名称,查看接口配置、参数列表、返回值列表和返回数据示例。
- 核对接口所有者、用途、输入条件和预期结果;不能只凭接口名称相近就提交申请。
- 对有敏感数据或调用限制的接口,先核对组织的访问要求和可用应用。
接口详情中的返回示例用于理解响应结构。实际返回内容受请求参数、数据权限和源系统状态影响。
申请 API
- 在目标 API 的列表操作中选择“申请”。
- 在申请窗口选择需要使用该 API 的应用和申请期限。
- 核对应用归属、目标接口和期限后提交。
- 管理员在“API 审核”中处理申请。
- 申请人在“我申请的 API”中查看审批与授权状态。
申请应绑定实际调用应用。若还没有应用,先阅读应用与授权;若需要他人创建的应用,先完成相应的应用申请。
归还与再次申请
使用结束后,在“我申请的 API”定位已授权记录;页面提供“归还”时可归还,后续需要使用则通过“再申请”重新提交。归还前检查仍在运行的调用任务,避免影响业务系统。申请期限、审批状态和实际调用资格应分别核对。
常见问题
| 现象 | 检查项 |
|---|---|
| 市场找不到目标 API | API 是否已经测试并发布,当前账号是否有可见权限 |
| 申请窗口没有目标应用 | 应用是否已创建或申请,状态是否允许使用 |
| 审批通过但无法调用 | 应用状态、API 状态、授权期限、请求参数和服务日志 |
| 返回内容与示例不同 | 实际查询条件、数据范围和接口定义的变更记录 |
