全部产品

API调用

更新时间:2020-08-28 18:07:03

在API发布后,用户可在应用中使用从API网关下载的SDK进行调用,本文介绍调用API的操作步骤。

前提条件

  • 已发布的API:必须是已发布的API方可调用。
  • 应用APP:调用API的是应用,因此需要在API网关中创建应用,通过应用对应的相关身份识别信息进行调用(API Owner拥有一个默认应用及对应的身份识别信息)。关于应用的更多介绍,请参见APP介绍
  • APP调用API的授权:应用需要拥有API的权限方可调用(API Owner,在发布时系统会对其默认APP进行授权操作)。

操作步骤

  1. 登录API网关的已授权API的SDK/文档自动生成页。

  2. 找到数据服务默认生成的DMS_DEFAULT_APP应用,单击右侧的各语言按钮进行下载SDK及文档(支持IOS、Android、JAVA)。

    • 其他语言(PHP/NodeJS/Python/.Net)参考控制台下方调用示例进行下载。

    • 从其他渠道(云市场)获得授权的API,请参见获取API文档进行操作。

    • 如果是子账号访问,需要主账号为子账号添加API网关资源的访问授权。API网关有2个官方权限策略,其中AliyunApiGatewayFullAccess是管理权限,AliyunApiGatewayReadOnlyAccess是只读权限。为子账号(RAM)授权的详情文档,请参见使用RAM管理API

  3. API调用页中,找到要调用的应用鉴权方式对应的身份识别码。

    • 简单认证模式,只需要appCode,适用于直接通过URL访问API,没有其他编程环境,一般用于可视化场景,如DataV调用,安全级别低。
    • 加密签名认证方式,则需要appKey和appSecret,通过在调用时动态生成加密签名来调用,安全级别高。关于如何在应用里如何签名调用,请参见调用文档

    1

  4. 获取API调用权限。

    • 对API Owner而言,此步可忽略,因为数据服务在发布API时已默认给API Owner的应用授予API的调用权限。
    • 对于非API Owner,则需要获取API调用权限,详情请参见获取权限
  5. 在应用中使用SDK调用API。