先决条件
你应该已经有了:
- 添加了一个数据存储和标签来groov,所以你有你的标签id。
- 建立一个API用户,所以你有你的API密钥。
或者,使用视图APIgroov史诗:
建立你的URL
对于这个示例,我们将使用数据存储API端点“列出所有标签”,位于/ api / v1 /数据存储/标记。
你查询的网址是你的网址groov(例如,https://my-groov.company.com)以及API端点。使用这个例子地址,我们完整的网址是:
https://my-groov.company.com/api/v1/data-store/tags让你的请求,您可以使用一个客户端(API用户添加groov构建),并提供用户的API密钥。
提供最简单的方法就是将它添加到你的URL作为一个额外的查询参数命名api_key。所以使用“列出所有标签”端点,你的网址是:
https://my-groov.company.com/api/v1/data-store/tags?api_key=MY_API_KEY也看到使用授权标头
在Windows上
您可以使用cURL将API请求。安装旋度。这是一个轻量级的命令行工具,可以将HTTP请求没有一个web浏览器。你可以尝试API请求命令提示符,而无需构建一个web应用程序工作。
cURL发出HTTP请求就像web浏览器,和web服务器的响应直接出现在您的命令行接口。这是你的卷发”列出所有标签“端点的请求:
curl - x美元,头接受:application / json的“https://my-groov.company.com/api/v1/data-store/tags?api_key=MY_API_KEY”你的反应在命令行界面是这样的:
[{" id ": 77年“的deviceId”: 7,“名字”:“#”,“数据类型”:"字符串"},{" id ": 79“的deviceId”: 7,“名字”:“数量”,“数据类型”:“整数”}]这里有一个带有两个标签在你的数据存储groov项目。你可以看到数据存储设备的id标签id(你需要查询),用户友好的标签名称和数据类型的标签。
在Linux或OSX
在类unix系统上,如Linux和OSX,你可能有旋度可用,发出请求使用简单:
curl - k美元“https://my-groov.company.com/api/v1/data-store/tags?api_key=MY_API_KEY”两个快速笔记使用cURL发出请求:
- 大多数groov实例使用自签名SSL证书,cURL将默认拒绝连接。的
- k选项告诉cURL允许请求使用一个未知的证书。 - 良好的实践来包装你的请求URL在单引号标记('):否则吗?和&符号在你的URL可能会混淆您的shell。
从当地的一个完整的例子groov实例是这样的:
localhost: ~用户curl - k美元的https://my-groov.company.com/api/v1/data-store/tags?api_key=nmLtALRF7Rqu2MJ9crid6c3Nu5KxqQTG' [ { "id" : 12, "deviceId" : 2, "name" : "my-boolean", "dataType" : "boolean" }, { "id" : 13, "deviceId" : 2, "name" : "my-integer", "dataType" : "integer" }, { "id" : 14, "deviceId" : 2, "name" : "my-float", "dataType" : "float" }, { "id" : 15, "deviceId" : 2, "name" : "my-string", "dataType" : "float" } ] localhost:~ user$在这个项目中,有四个数据存储标签和端点返回他们的标签id(所需查询),用户友好的名称、数据类型和数据存储设备的id。
更多请求的例子
如果你在groov构建中,您可以看到更多的URL和旋度为自己的groov项目的例子。
选择帮助>groov公共API, API的示例页面。只需点击试试!按钮的端点。(这些按钮是可用的,当你查看页面groov从API参考页面构建,但不是在开发者网站。)
既然你已经通过身份验证groov构建,你可以阅读,而不必输入您的API密钥。写,点击红色感叹号和对话框中输入您的API密匙:
为groov史诗,看到设备的具体说明。
使用标签id
当你添加一个groov数据存储和它的标签,每个标签被分配一个标签id。许多API请求要求标签id,它表现为一个参数的端点。例如,数据存储API的“读单个标签的价值”的端点/ api / v1 /数据存储/读/ <标签id >
如果你有一个单一标签id 77,网址读取该值是:
https://my-groov.company.com/api/v1/data-store/read/77?api_key=MY_API_KEY响应可能会看起来像这样:
[{" id ": 77,“valueType”:“stringValue”、“价值”:“ABC45”}]你看到你的标签id,数据的类型,和当前值标签。
写作。写一个标签是相似的;写的是另一个参数的值。例如,数据存储API的“写一个标签的值”端点/ api / v1 /数据存储/写/ <标签id >吗? <值>
所以你的请求URL是:
https://my-groov.company.com/api/v1/data-store/write/79?value=20&api_key=MY_API_KEY和响应将是这样的:
[{" id ": 79,“valueType”:“integerValue”、“价值”:20}]你看到标签id,其数据类型,和你写的价值。
使用表格
假设你想读标签在一个表中。再次让我们使用的端点/ api / v1 /数据存储/阅读/ <标签id > ?指数= <表索引>数= < table-count >
这一次您将使用可选的指数和数查询参数。如果你有一个表id为80的标签,你想读4元素从它开始索引3,你的网址是:
https://my-groov.company.com/api/v1/data-store/read/80?count=4&index=3&api_key=MY_API_KEY注意:如果你正在阅读一个表标签,你不提供索引或计数参数,默认为0和1,分别。
你的反应可能会看起来像这样:
[{" id ": 80,“valueType”:“stringArrayValue”、“价值”:[“AB450”、“AC230”,“AA670”、“AT540”]}]这四个值要求订单所示。指数3 = AB450,指数4 = AC230,等等。
写作。写信给一个表是相似的,除了你写一个元素。这是要求:
https://my-groov.company.com/api/v1/data-store/write/80?index=7&value=AR950&api_key=MY_API_KEY这是反应:
[{" id ": 80,“valueType”:“stringArrayValue”、“价值”:“AR950”}]响应验证在此表的索引7,你写AR950价值。
下一个步骤
如果需要,请参阅: