在DataV-Board中添加API数据源_DataV数据可视化(DataV)-阿里云帮助中心

API是数据应用接口，允许不同的软件应用程序进行通信和数据交换。本文档介绍在DataV-Board中添加API数据源的方法，以及相关参数配置说明。

前提条件

重要

请确保API的URL地址能被公网访问。

仅支持企业版及以上版本。

当您使用API时，可能存在跨域或者需要cookie获取信息情况，系统通过服务器代理请求和需要cookie配置项支持。具体操作参见下表。

按实际情况填写API参数。

参数名称	描述
请求方式	选择API接口的请求类型，支持GET和POST两种类型，默认为GET。 GET：从服务器请求数据。 POST：向服务器提交要被处理的数据。具体这两种请求方式的解释说明，请参见常用的请求方式。
URL	输入API接口的请求地址。重要请确保URL的地址能被公网访问，支持域名或者IP。
Headers	请求头参数，即包含在HTTP请求中的元数据，用于传递附加信息。
Body	请求体参数，即请求中实际传输的数据部分。仅POST请求方式时需设置。
服务器代理请求	URL地址跨域无法访问时，勾选。重要此时需要cookie选项不生效。
需要cookie	可使用cookie实现数据权限控制，保证数据安全性。此时不可勾选服务器代理请求，具体场景和原理见cookie使用说明。

说明

Headers和Body参数格式为key&value格式，可使用JSON编辑器直接输入JSON格式数据。一旦切换，无法返回可视化编辑模式，请谨慎切换。

网站http://exampleA.com访问网站http://exampleB.com的数据接口，将无法获取数据。打开浏览器，您可以看到如下标记为红色的文字（Chrome）。这意味着我们遇到了跨域问题。

XMLHttpRequest 无法加载 http://exampleB.com。所请求的资源不带有“Access-Control-Allow-Origin”报头。因此不允许源站点“http://exampleA.com”进行访问。

说明

跨域：若两个页面的协议（HTTP）、端口（80）和域名（example.com）任意一个不相同，则该页面之间的资源请求被认为是跨域。

当API地址存在跨域问题时，通过以下两种方式解决：

可直接勾选服务器代理请求解决。
通过跨域资源共享方式解决。
重要
当API同时需要cookie信息时，只能通过跨域资源共享的方式一和方式二解决，必须明确返回需要被支持的跨域域名。

跨域资源共享（CORS, Cross-Origin Resource Sharing）是一种机制，使得浏览器可以请求来自与其所在的服务器不同的域上资源。基本原理为在源站点（被请求一方）中加入自定义的HTTP头部，使其他网站可以访问其资源。配置方法如下：

方法一：若源站点的接口数据需要被某一个网站使用，在数据服务器返回的报头信息中加入以下内容。
```
Access-Control-Allow-Origin: http://exampleA.com
```
方法二：若源站点的接口数据需要被多个网站使用，必须使用一个程序来动态生成报头信息。以PHP代码为例。
```
<?php 
if (is_my_code($_SERVER['HTTP_ORIGIN'])) {
header("Access-Control-Allow-Origin: {$_SERVER['HTTP_ORIGIN']}");
}
?>
```
方法三：若源站点的接口数据需要被所用的网站使用，可以使用“*”。
```
Access-Control-Allow-Origin: *
```

当数据看板通过iframe嵌入业务系统时，可使用cookie实现数据隔离。即在用户登录的情况下，业务系统中带有用户登录信息Session_Id的cookie。此时，可通过cookie获取对应用户信息。

当使用API数据源，并且选中了需要cookie（不选择代理并且需要获取cookie时使用）时，DataV-Board会在HTTPS请求中带上该页面包含用户登录信息的cookie。
重要
- 当选中需要cookie时，不可同时选中服务器代理请求。
此时服务端会对请求进行用户验证，通过后返回该用户的数据，从而实现不同用户登录只看到自己数据，而看不到其他用户的数据。

获取原始数据后，可参见组件数据源配置进行组件数据的适配。