应用是数据服务消费API的主体,一个应用可以对接多个API。在您开始调用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的应用。

  1. 进入平台管理,详情请参见进入平台管理
  2. 平台管理页面,单击左侧导航栏应用管理
  3. 应用管理页面,创建或申请应用。
    • 创建应用:
      1. 单击页面右上方的创建应用
      2. 创建应用对话框,选择应用分组应用名称
      3. 单击确定,完成应用的创建。
    • 申请应用:
      1. 查询需要申请的应用,单击申请状态下的立即申请
      2. 进入Dataphin权限管理模块,申请应用的权限,详情请参见申请应用权限

        申请权限的流程及申请状态,在通知中心的我发起的模块查看,详情请参见查看我发起的任务

      管理已申请或创建的应用。
      操作 说明
      编辑 单击操作列下的faga图标,编辑应用。
      删除 单击操作列下的gaga图标,删除应用。

步骤二:查询API

  1. 进入数据服务总览,详情请参见进入数据服务
  2. 数据服务总览页面,单击左侧导航栏API服务
  3. 单击文档说明列下的API文档,查看API是否符合您的业务场景。

步骤三:申请API

  1. 进入数据服务总览,详情请参见进入数据服务
  2. 数据服务总览页面,单击左侧导航栏API服务
  3. API服务页面,单击申请状态下的立即申请
    您也可以执行以下操作,进入API权限申请页面:
    1. 进入个人工作台,详情请参见进入个人工作台
    2. 个人工作台页面,单击左侧导航栏中服务调用下的API服务
    3. API服务页面,单击申请API
  4. API权限申请页面,申请API权限,详情请参见申请API权限

步骤四:调试API

  1. 进入个人工作台,详情请参见进入个人工作台
  2. 个人工作台页面,单击左侧导航栏API服务
  3. 单击操作列下的gaga图标,进入API调试页面。
  4. API调试对话框,配置参数。
    API调试时,您可以选择调试开发环境还是生产环境的API。
    区域 参数 描述
    业务请求参数列表 调试输入值 填写必填参数的调试输入值
    公共请求参数列表 调试输入值 根据公共请求参数列表页面提示,填写调试输入值
    • appkey调试输入值填写为API所在应用的AppKey。
    • appsecret调试输入值填写为API所在应用的AppSecret。
    可返回参数列表 返回参数 选择返回的参数。
    协议 选择协议 如果新建API时选择了HTTP和HTTPS,则调试时,您可以选择协议。
    返回条数 选择返回条数 选择返回结果的条数。
  5. 完成参数配置后,单击调试
  6. 查看返回结果后的测试结果,单击查看错误代码表查看API错误代码。
    如果调试结果为失败,您可以单击操作列下的faga图标,根据页面提示单击确定,即可将API与应用解绑。

步骤五:调用API

  1. 进入平台管理页面,详情请参见进入平台管理
  2. 平台管理页面,单击左侧导航栏的调用示例
  3. 调用示例页面,单击API调用示例,查看调取SDK代码配置的模板。
  4. API调用示例页面,单击SDK下载,下载SDK代码包。
  5. 配置应用的SDK代码,详情请参见API调用示例模板。