本页采用了机器翻译。点击此处可查看最新英文版本。

Write Settings

使用 HTTP PUT 更新通道设置

请求

描述

使用此请求来写入通道设置。通道设置包括通道描述、字段名称、通道位置、元数据、公共或私有状态、通道名称。

HTTP 方法

PUT

URL

https://api.thingspeak.com/channels/<channel_id>.<format>

URL 参数

名称描述

<channel_id>

（必填）感兴趣通道的通道 ID。

<format>

（必需）HTTP 响应的格式，指定为 json 或 xml。

示例： https://api.thingspeak.com/channels/266256.json

主体参数

名称描述值类型
api_key（必填）指定用户 API 密钥，您可以在个人资料中找到该密钥。此密钥与通道 API 密钥不同。字符串
description（可选）通道描述。字符串
field1

（可选）字段 1 的名称。

字符串
field<X>

（可选）字段 X 名称，其中 X 是字段 ID。

字符串
latitude

（可选）纬度（以度为单位），指定为 -90 和 90 之间的值。

小数
longitude

（可选）经度（以度为单位），指定为 -180 和 180 之间的值。

小数
elevation

（可选）海拔（以米为单位）。

整数
metadata

（可选）通道的元数据，可以包括 JSON、XML 或任何其他数据。

文本
name

（可选）通道名称。

字符串
public_flag

（可选）该通道是否为公共通道。默认值为 false。

true 或 false
tags

（可选）以逗号分隔的标签列表。

字符串
url

（可选）通道的网页 URL。

字符串

Content-Type

application/x-www-form-urlencoded

响应

成功

HTTP 状态代码

200 OK

主体
PUT https://api.thingspeak.com/channels/4.json
    api_key=XXXXXXXXXXXXXXXX
    name=Updated Channel

响应是更新后的通道信息的 JSON 对象，例如：

{
  "id": 4,
  "name": "Updated Channel",
  "description": null,
  "metadata": null,
  "latitude": null,
  "longitude": null,
  "created_at": "2014-03-25T13:12:50-04:00",
  "elevation": null,
  "last_entry_id": null,
  "ranking": 15,
  "username": "iothans",
  "tags": [],
  "api_keys":
  [
    {
      "api_key": "XXXXXXXXXXXXXXXX",
      "write_flag": true
    }
  ]
}
PUT https://api.thingspeak.com/channels/4.xml
    api_key=XXXXXXXXXXXXXXXX
    name=Updated Channel

响应是更新后的通道信息的 XML 对象，例如：

<?xml version="1.0" encoding="UTF-8"?>
<channel>
    <id type="integer">4</id>
    <name>Updated Channel</name>
    <description nil="true" />
    <metadata nil="true" />
    <latitude type="decimal" nil="true" />
    <longitude type="decimal" nil="true" />
    <created-at type="dateTime">2014-03-25T20:17:44-04:00</created-at>
    <elevation nil="true" />
    <last-entry-id type="integer" nil="true" />
    <ranking type="integer">15</ranking>
    <username>iothans</username>
    <tags type="array" />
    <api-keys type="array">
        <api-key>
            <api-key>XXXXXXXXXXXXXXXX</api-key>
            <write-flag type="boolean">true</write-flag>
        </api-key>
    </api-keys>
</channel>

错误

完整列表请参阅错误代码。

示例

使用 POSTMAN 编写通道设置

您可以使用 POSTMAN 尝试使用 ThingSpeak 的 RESTful API 发出 HTTP 请求。此示例展示如何使用 POSTMAN 编写新的通道设置。

使用现有通道，将通道名称更改为 Updated Channel 并将字段 1 标题更改为 Heart Rate。还将共享更改为公共。

PUT https://api.thingspeak.com/channels/CHANNEL_ID
    api_key=XXXXXXXXXXXXXXXX
    name=Updated Channel
    public_flag=true
    field1=Heart Rate

  1. 在 POSTMAN 中，从 HTTP 动词下拉列表中选择 PUT，然后在地址栏中输入 api.thingspeak.com/channels/<CHANNEL_ID>.json，将 <CHANNEL_ID> 替换为感兴趣的通道。

  2. 在值栏输入参数 api_key，输入您的 User API Key，可以在 Account > My Profile 中找到。

  3. 输入其他参数和值：

    • name，Value：Updated Channel

    • field1，Value：Heart Rate

    • public_flag，Value：True

响应采用 JSON 格式。注意服务器响应值为 200 OK，表示成功写入新通道设置。

新的通道设置现已在您的通道页面上提供。

附加材料

另请参阅

| | |

主题