数据服务快速开始
以一个已获准开放的接口为例,完成“开发 API、测试、发布、申请并核对调用”的最小流程。开始前确认数据来源、接口所有者、审批人和测试账号;不要用生产敏感数据作为首次调试样本。
1. 准备调用应用
应用工程师在“我创建的应用”中新建应用,填写业务用途等页面要求的信息。创建后检查应用状态,并妥善保存应用凭据。需要使用他人创建的应用时,按应用申请提交申请,不能借用其他人的密钥。
2. 创建并测试 API
数据工程师进入“我开发的 API”,新增接口并填写 API 配置。保存后先在详情页测试,核对请求参数、返回内容和错误响应。测试成功是发布的前提;一次测试通过不代表所有输入和权限路径都已经覆盖。
3. 发布到 API 市场
按API 开发与发布发布已测试的接口。发布后从 API 市场检索同一名称,打开详情核对接口参数、返回值及示例。已发布接口需要修改时,应先按页面提供的下线和编辑流程处理,避免调用方在无通知的情况下遇到契约变化。
4. 申请使用
在 API 市场选择目标 API,提交申请时选择调用应用和申请期限。管理员审核后,申请人在“我申请的 API”查看结果。申请通过后再以获授权的应用进行调用,不把审批列表中的“已通过”当作接口已经可正常返回数据。
5. 验证结果
使用受控请求调用 API,检查响应与说明一致,并在 API 或应用访问监控中核对调用记录。失败时依次检查应用状态、API 状态、授权期限、请求参数和服务日志。
完成标志
API 可以在市场中找到,申请记录和授权对象一致,目标应用可以使用受控参数调用接口,调用记录可追溯。若环境中没有相应菜单或权限,先由管理员核对模块授权和角色配置。
