Skip to content

如何安全调用数据API

此章节主要介绍如何使用数据API的过程，在API创建完成后，主要的API的使用主要有三种方式：

  1. 链接分享的方式：不需要平台的用户，只需要类似百度链接的分享链接的方式，让平台的外部用户可以直接通过分享地址和验证码就可以下载相关的数据，数据的下载格式默认为csv的格式（支持大数据量同时兼容Excel的格式）。
  2. 数据市场：可以通过数据市场直接查看和下载数据API的数据，但需要此用户有需要访问的数据API的权限（具体的关于用户和权限的内容可以参考用户和权限的相关的章节），用户可以在数据市场直接查看样本数据，同时支持CSV和Excel格式的数据下载。当然，用户也可以在数据市场查看相关的数据API的接口地址和相应的参数列表。
  3. API Restful接口调用：在通过数据市场或直接由API管理员或系统管理员admin在数据API页面获取数据的接口地址后，可以直接使用应用程序比如JAVA或其他语言或测试工具如Postman完成测试。

1 链接分享的方式

链接分享的方式本身主要是用来给外部用户访问数据来使用的，用户本身是匿名的，但是又想获取相关的数据。

主要的应用场景为：

公司三方的用户希望能获取和他有关的数据，但本身又不是公司的基本用户或者这个用户的访问是临时性的，这时候数据API可以自动生成相关的分享链接，分享链接有自身的安全性控制：

  1. 可以将用户需要输入的参数分享给用户输入（有一定的灵活性但安全性较差），也可以由公司管理员把参数输入好后再生成链接出去（比如不同的供应商只能查看自己相关的数据），默认是不分享参数出去，安全性较高。
  2. 管理员可以设置分享链接可以访问的次数。
  3. 管理员可以设置分享链接可以访问的有效时间。

a. 首先进入分享的页面

b. 配置分享的页面并拷贝相应的分享链接和验证码

c. 接下来可以复制链接及提取码并分享给相应的外部用户来使用了。如果忘记了相应的链接和验证码，可以在数据API的管理页面查看相应的数据API的信息里面有相应的信息，同时还有分享链接的外部访问情况。

2 数据市场

数据市场是内部的用户来访问相应的数据API的主要的地方。目前数据市场的访问根据用户的基本角色的不同（指的是系统管理员，API管理员和业务用户等），页面显示不一样。如果是系统管理员，只显示全部的数据API，如果是其他的，还会显示我的空间（我的空间里面是自己有权限的数据API），以下是用系统管理员访问的页面，其他基本角色的访问基本相似。

a. 首先进入到数据市场的页面。

b. 接下来点击相应的数据API就可以进入到数据API的详情页面。

c. 在有权限的情况下，会看到上方有获取数据相应的按钮，点击就可以进入到样本数据和下载的页面。

3 API Restful接口调用

生成的API根据接口生成时的类型的不同有Get和Post两种方式（主要是为了数据API的简洁性和通用性）。此处是以Get为接口方式来示例讲解如何调用相应的数据API。

第一步：获取相应的API Restful的接口调用地址：

查看了上述的两种方式后，以下主要是展示一下两个页面的入口以及如何获取相应的数据API的接口地址。

  1. 从数据API的目录处获取相应的数据API的地址和参数情况。

  1. 从数据市场的地方获取相应的数据API的地址和参数情况（推荐获取方式，更规范）。

第二步：使用PostMan来调用和测试数据API：

因为数据安全的基础要求，要想调用相应的API，需要用户有相应的数据API的调用权限，此处以管理员为例来测试调用数据API，如是其他角色的用户，需要在用户页面进行相应的权限的分配后才能调用，以下主要分为两个步骤完成。

  1. 调用apiAuthenticate接口（类似login接口）先获取相应的apiToken的值。

  1. 使用刚刚获取的apiToken来调用相应的数据API，请注意相应的调用方法（Get还是Post)，调用地址还有参数和Header（apiToken要放到调用的Header中）

  1. 如果是代码相关的调用，可以根据postman上面测试的实际情况来进行开发使用。