Esta página se ha traducido mediante traducción automática. Haga clic aquí para ver la versión original en inglés.

Write Settings

Actualizar la configuración del canal con HTTP PUT

Solicitud

Descripción

Use esta solicitud para escribir la configuración del canal. La configuración del canal incluye la descripción del canal, los nombres de los campos, la ubicación del canal, los metadatos, el estado público o privado y el nombre del canal.

Método HTTP

PUT

URL

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

Parámetros de URL

Nombre	Descripción
<channel_id>	(Obligatorio) ID de canal para el canal de interés.
<format>	(Obligatorio) Formato para la respuesta HTTP, especificado como json o xml.

Ejemplo: https://api.thingspeak.com/channels/266256.json

Parámetros del cuerpo

Nombre	Descripción	Tipo de valor
api_key	(Obligatorio) Especifique la clave API de usuario, que puede encontrar en su perfil. Esta clave es diferente de las claves API del canal.	cadena
description	(Opcional) Descripción del canal.	cadena
field1	(Opcional) Nombre del campo 1.	cadena>
field<X>	(Opcional) Nombre del campo X, donde X es el ID del campo.	cadena
latitude	(Opcional) Latitud en grados, especificada como un valor entre -90 y 90.	decimal
longitude	(Opcional) Longitud en grados, especificada como un valor entre -180 y 180.	decimal
elevation	(Opcional) Elevación en metros.	entero
metadata	(Opcional) Metadatos para el canal, que pueden incluir JSON, XML o cualquier otro dato.	texto
name	(Opcional) Nombre del canal.	cadena
public_flag	(Opcional) Si el canal es público. El valor predeterminado es falso.	true o false
tags	(Opcional) Lista de etiquetas separadas por comas.	cadena
url	(Opcional) URL de la página web del canal.	cadena

Tipo de contenido

application/x-www-form-urlencoded

Respuesta

Éxito

Código de estado HTTP

200 OK

Cuerpo

 Ejemplo JSON

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

La respuesta es un objeto JSON de la información del canal actualizada, por ejemplo: { "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 } ] }

 Ejemplo XML

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

La respuesta es un objeto XML de la información del canal actualizada, por ejemplo: <?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>

Error

Para obtener la lista completa, consulte Códigos de error.

Ejemplos

Use POSTMAN para escribir la configuración del canal

Puedes usar POSTMAN para probar sus solicitudes HTTP utilizando la API RESTful para ThingSpeak. Este ejemplo muestra cómo escribir nuevas configuraciones de canales usando POSTMAN.

Usando un canal existente, cambie el nombre del canal a Updated Channel y el título del campo 1 para Heart Rate. También cambie el uso compartido a Público.

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

1. En POSTMAN, seleccione PUT de la lista desplegable de verbos HTTP e ingrese api.thingspeak.com/channels/<CHANNEL_ID>.json en la barra de direcciones, reemplazando <CHANNEL_ID> con el canal de interés.

2. Introduzca el parámetro api_key en la columna de valor, ingrese su clave API de usuario, que se encuentra en Account > My Profile.

3. Introduzca parámetros y valores adicionales:

   • name, Value: Updated Channel

   • field1, Value: Heart Rate

   • public_flag, Value: True

La respuesta está en formato JSON. Tenga en cuenta el valor de respuesta del servidor de 200 OK, lo que indica que se ha escrito correctamente la configuración del nuevo canal.

La nueva configuración de canales ya está disponible en su canales página.

Material adicional

Consulte también

List Your Public Channels | List Your channels | List Channels | Read Settings

Temas

• Propiedades del canal