文档

调用API

更新时间:

在API发布并授权之后,您可以通过简单身份认证(在请求头中添加AppCode)或加密签名身份认证(在请求头中添加AppKey和AppSecret)的方式调用API。本文为您介绍如何获取认证信息以及调用API的具体流程。

前提条件

您需要首先发布API至API网关,详情请参见发布API

您需要获取以下三个基础条件,才可以调用API:

  • API:您即将要调用的API,明确API参数定义。

  • 应用App:作为您调用API时的身份,AppKey和AppSecret用于验证您的身份。

  • API和App的权限关系:App需要调用某个API,必须获取调用该API的权限。详情请参见授权管理

背景信息

API网关支持API授权和API调用SDK。您可以授权自己、企业内的人员或第三方使用API。

操作步骤

  1. 获取API文档。

    根据您获取API的渠道不同,获取方式略有差异。通常分为以下两种方式:

    • 从数据市场购买的API服务。如需查看已购API列表,请在云市场控制台中查询。详情请参见云市场控制台

    • 无需购买,由提供方主动授权的API服务。如需查看获得授权的API服务,请在API网关控制台中查询。详情请参见API网关控制台

  2. 创建应用。

    应用App是您调用API服务时的身份。每个App有一组Key和Secret,即账号和密码。详情请参见创建应用

  3. 获取权限。

    授权是指授予App调用某个API的权限。您的App需要获取API的授权才能调用该API。

    由于获取API的渠道不同,建立授权的方式也不同。详情请参见获取授权

  4. 调用API。

    您可以直接用API网关控制台为您提供的多语言调用示例来测试调用,可以自行编辑HTTP(S)请求来调用API。详情请参见客户端调用API示例支持 HTTPS

查看API调用的认证信息

  1. 登录DataWorks控制台,单击左侧导航栏的数据服务,在下拉框中选择对应工作空间后单击进入数据服务

  2. 数据服务页面,单击右上方的服务管理

  3. 在左侧导航栏,单击API调用

    API调用页面,您可以根据自身需求,查看或复制调用API时需要的身份认证信息。