史诗般的开发人员之家

或去史诗般的REST API概述

PAC控制API可以在Epic上访问什么

PAC控制REST API用于访问PAC控制变量用于当前在Epic控制引擎上运行的策略。要访问I/O,您应该使用格鲁夫管理REST API,并访问任何格鲁夫您应该使用的数据存储标签格鲁夫查看REST API

入门

启动之前请求Python软件包,或其他一些界面卷曲或者邮差。在下面的示例中,我们将使用卷发。

步骤1-身份验证

请求使用API​​键进行身份验证,其中每个格鲁夫EPIC用户具有与其帐户关联的API密钥。

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

提出请求时,需要将API密钥添加为名为“ Apikey”的自定义HTTP标头。

创建仅API的用户:

  1. 格鲁夫管理。
  2. 导航到帐户菜单。
  3. 选择添加创建新用户。
  4. 设置用户名和密码。
  5. 确保用户具有PAC控制REST API读写权限。
  6. 选择节省
  7. 从帐户列表中选择该用户,然后复制用于在应用程序中使用的API密钥。

顶部

步骤2-构建请求

要提出请求,您将需要由两个部分组成的特定URL:主机名或IP地址格鲁夫Epic处理器和请求的URL路径,以及API键的标题步骤1

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

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

在此示例中,我们将查看具有URL路径的INT32变量列表/设备/策略/vars/int32S

顶部

步骤3-执行请求

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

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

curl -k -k -x获取“ https:// opto-01-02-03/pac/pac/pact/deviction/stragings/vars/int32s“ -h” accept:application/json“ -h” apikey:3kblb7yzrxntbp49nemobdkrpmpmpkfobobo”

-K标志用于忽略任何SSL错误。默认情况下,Groov Epic处理器使用自签名的SSL证书,但是您的计算机和卷发没有参考。为了使这些示例更容易,我们只是忽略了-K标志的问题。这些请求仍将被加密,但是证书本身将无法验证。

使用-H标志设置API键,该键在请求中添加了名为“ Apikey”的自定义HTTP标头。

如果您运行上述命令(对自己的地址和API密钥进行调整),则响应应该如下:

[{“ nmyveryfavoriteNumber”22},,{“ nwidgetsproducedtoday”31415},,{“ delay_loop_time_in_msecs”250}这是给出的

该数组中的每个条目是PAC控制策略中的INT32变量,在请求响应时具有关联的值。

结论

开发人员API参考为了访问特定的整数值,浮子,字符串,表,计时器,策略信息,甚至I/O,如果您想为此使用PAC控制API。为了使构建请求的过程更加简单,并包含了开发人员的说明自动生成要求从史诗本身获取确切的URL。

顶部