应用是数据服务消费API的主体,一个应用可以对接多个API。在您开始调用API前,需要创建或申请应用、查询API、申请API和调试API。
背景信息
应用(消费)API的流程说明。
流程 |
描述 |
创建或申请应用 |
应用是数据服务消费API的主体。在您申请API前需要先申请或创建应用。 |
查询API |
在数据服务市场中,通过查看API文档的方式,查询适合您业务场景的API。 |
申请API |
申请数据服务市场中需要消费API的权限。 |
调试API |
调用API前需要对API进行调试,以保证数据的安全稳定。 |
调用API |
API调用方式包括SDK和Postman,建议您使用SDK调用方式。Postman的调用方式只适用于调试和开发API的场景。 |
步骤一:创建或申请应用
您可以通过申请已有应用的权限、或创建应用获取消费API的应用。
- 进入平台管理,详情请参见进入平台管理。
- 在平台管理页面,单击左侧导航栏应用管理。
- 在应用管理页面,创建或申请应用。
- 创建应用:
- 单击页面右上方的创建应用。
- 在创建应用对话框,选择应用分组和应用名称。
- 单击确定,完成应用的创建。
- 申请应用:
- 查询需要申请的应用,单击申请状态下的立即申请。
- 进入Dataphin权限管理模块,申请应用的权限,详情请参见申请应用权限。
申请权限的流程及申请状态,在通知中心的我发起的模块查看,详情请参见查看我发起的任务。
管理已申请或创建的应用。
操作 |
说明 |
编辑 |
单击操作列下的 图标,编辑应用。 |
删除 |
单击操作列下的 图标,删除应用。 |
步骤二:查询API
- 进入数据服务总览,详情请参见进入数据服务。
- 在数据服务总览页面,单击左侧导航栏API服务。
- 单击文档说明列下的API文档,查看API是否符合您的业务场景。
步骤三:申请API
- 进入数据服务总览,详情请参见进入数据服务。
- 在数据服务总览页面,单击左侧导航栏API服务。
- 在API服务页面,单击申请状态下的立即申请。
您也可以执行以下操作,进入
API权限申请页面:
- 进入个人工作台,详情请参见进入个人工作台。
- 在个人工作台页面,单击左侧导航栏中服务调用下的API服务。
- 在API服务页面,单击申请API。
- 在API权限申请页面,申请API权限,详情请参见申请API权限。
步骤四:调试API
- 进入个人工作台,详情请参见进入个人工作台。
- 在个人工作台页面,单击左侧导航栏API服务。
- 单击操作列下的
图标,进入API调试页面。
- 在API调试对话框,配置参数。
API调试时,您可以选择调试开发环境还是生产环境的API。
区域 |
参数 |
描述 |
业务请求参数列表 |
调试输入值 |
填写必填参数的调试输入值。 |
公共请求参数列表 |
调试输入值 |
根据公共请求参数列表页面提示,填写调试输入值:
- appkey的调试输入值填写为API所在应用的AppKey。
- appsecret的调试输入值填写为API所在应用的AppSecret。
|
可返回参数列表 |
返回参数 |
选择返回的参数。 |
协议 |
选择协议 |
如果新建API时选择了HTTP和HTTPS,则调试时,您可以选择协议。 |
返回条数 |
选择返回条数 |
选择返回结果的条数。 |
- 完成参数配置后,单击调试。
- 查看返回结果后的测试结果,单击查看错误代码表查看API错误代码。
如果调试结果为失败,您可以单击
操作列下的

图标,根据页面提示单击
确定,即可将API与应用解绑。
步骤五:调用API
- 进入平台管理页面,详情请参见进入平台管理。
- 在平台管理页面,单击左侧导航栏的调用示例。
- 在调用示例页面,单击API调用示例,查看SDK调用和API-TOKEN调用的代码模板和注意事项。
您也可以单击
默认调用示例下载,下载API调用示例。
如果需要通过SDK方式调用API,则单击SDK下载,下载SDK代码包。