史诗般的开发人员之家

或去史诗般的REST API概述

Groov视图API可以在Epic上访问什么

凹槽查看REST API用于访问凹槽您使用的数据店标签凹槽通过设备和标签接口在凹槽查看构建。要访问策略变量,您应该使用PAC控制REST API,要访问i/o,您应该使用凹槽管理REST API

先决条件

在开始之前,您需要一个HTTPS客户端,例如,您选择的编码语言的HTTPS编程库,例如请求Python软件包,或其他一些界面卷曲或者邮差。在下面的示例中,我们将使用卷发。

你也应该有一个数据存储准备好,并带有一些标签读写。

步骤1-身份验证

请求使用API​​密钥对请求进行身份验证,凹槽EPIC用户具有与其帐户关联的API密钥。

要查找用户的API密钥,请打开凹槽在Web浏览器中管理并导航到帐户页面并单击用户。API键在页面底部附近列出。

提出请求时,需要添加API密钥作为URL属性?api_key =

创建仅API的用户:

  1. 凹槽管理。
  2. 导航到帐户菜单。
  3. 选择添加创建新用户。
  4. 设置用户名和强大的随机密码。
  5. 确保用户有凹槽看法编辑权限。
  6. 选择
  7. 从帐户列表中选择该用户,然后复制用于在应用程序中使用的API键。

最佳

步骤2-构建请求

要提出请求,您将需要特定的URL(请参阅上一页有关更多详细信息)由三个部分组成:主机名或IP地址凹槽EPIC处理器,请求的URL路径和API键第1步。如果提出写请求,我们还需要包括值。

在此示例中,我们将使用一个示例主机名Opto-01-02-03对于地址,使用关联的API密钥3KBLB7YZRXNTBP49NEMOBDKRPMPKFOBO

URL扩展的细节可以在开发人员API参考或遵循自动生成请求的步骤从史诗本身获取确切的URL。

在此示例中,我们将查看具有URL路径的数据商店标签列表/v1/数据储物/标签

最佳

步骤3-执行请求

带有来自API键的第1步和来自第2步我们准备提出请求。

笔记:凹槽史诗至关重要/view/api/在主机名和URL路径之间指定所使用的接口。因此,卷曲请求看起来像这样:

curl -x获取“ http:// epic -dev/view/api/v1/data -store/tags?api_key = 3KBlB7YZRXNTBP49NEMOBDKRPMPKRPKFOBO” -h accept:application/json acpersption:application/json”

响应类型是用- 头(或者-H)标志要请求JSON形式的响应,如果您运行上述命令(根据自己的地址和API键进行调整),应该看起来像这样:

[[{“ID”77,,,,“设备编号”7,,,,“名称”“部分 #”,,,,“数据类型”“细绳”},,{“ID”79,,,,“设备编号”7,,,,“名称”“数量”,,,,“数据类型”“整数”}这是给予的

数组中的每个条目是一个数据存储标签,并在请求响应时具有关联的ID,设备,名称和数据类型。然后,我们可以跟进此路径以获取特定值/v1/data-store/read/{id},或覆盖“数量“ 使用/v1/data-store/write/79?value = 22&api_key = ...

结论

开发人员API参考访问特定的数据商店标签和凹槽查看信息。为了使构建请求的过程更加简单,并包含了开发人员的说明自动生成要求从史诗本身获取确切的URL。

最佳