Cette page a été traduite par traduction automatique. Cliquez ici pour voir la version originale en anglais.

Write Settings

Mettre à jour les paramètres du canal avec HTTP PUT

Requête

Description

Utilisez cette requête pour écrire les paramètres du canal. Les paramètres de canal incluent la description du canal , les noms de champ, l'emplacement du canal , les métadonnées, le statut public ou privé et le nom du canal.

Méthode HTTP

PUT

URL

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

Paramètres d'URL

Nom	Description
<channel_id>	(Obligatoire) ID du canal pour le canal d’intérêt.
<format>	(Obligatoire) Format de la réponse HTTP, spécifié comme json ou xml.

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

Paramètres du corps de la requête

Nom	Description	Type de valeur
api_key	(Obligatoire) Spécifiez la clé API utilisateur, que vous pouvez trouver dans votre profil. Cette clé est différente des clés d'API de canal.	chaîne de caractère
description	(Facultatif) Description du canal.	chaîne de caractère
field1	(Facultatif) Nom du champ 1.	chaîne de caractère>
field<X>	(Facultatif) Nom du champ X, où X est l'ID du champ.	chaîne de caractère
latitude	(Facultatif) Latitude en degrés, spécifiée comme une valeur comprise entre -90 et 90.	décimal
longitude	(Facultatif) Longitude en degrés, spécifiée comme une valeur comprise entre -180 et 180.	décimal
elevation	(Facultatif) Altitude en mètres.	entier
metadata	(Facultatif) Métadonnées du canal, qui peuvent inclure JSON, XML ou toute autre donnée.	texte
name	(Facultatif) Nom du canal.	chaîne de caractère
public_flag	(Facultatif) Indique si le canal est public. Le défaut est faux.	true ou false
tags	(Facultatif) Liste de balises séparées par des virgules.	chaîne de caractère
url	(Facultatif) URL de la page Web du canal.	chaîne de caractère

Type de contenu

application/x-www-form-urlencoded

Réponse

Succès

Code HTTP status

200 OK

Body

 Exemple JSON

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

La réponse est un objet JSON des informations de canal mises à jour, par exemple : { "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 } ] }

 Exemple XML

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

La réponse est un objet XML des informations de canal mises à jour, par exemple : <?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>

Erreur

Pour la liste complète, voir Codes d'erreur.

Exemples

Utiliser POSTMAN pour écrire les paramètres du canal

Vous pouvez utiliser POSTMAN pour tester vos requêtes HTTP à l'aide de l'API RESTful pour ThingSpeak. Cet exemple montre comment écrire de nouveaux paramètres de canal à l'aide de POSTMAN.

En utilisant un canal existant, changez le nom du canal en Updated Channel et le titre du champ 1 en Heart Rate. Changez également le partage en Public.

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

1. Dans POSTMAN, sélectionnez PUT dans la liste déroulante des verbes HTTP et entrez api.thingspeak.com/channels/<CHANNEL_ID>.json dans la barre d'adresse, en remplaçant <CHANNEL_ID> par le canal qui vous intéresse.

2. Entrez le paramètre api_key dans la colonne valeur, entrez votre clé API utilisateur, qui se trouve dans Account > My Profile.

3. Entrez des paramètres et des valeurs supplémentaires :

   • name, Value: Updated Channel

   • field1, Value: Heart Rate

   • public_flag, Value: True

La réponse est au format JSON. Notez la valeur de réponse du serveur de 200 OK, indiquant la réussite de l'écriture des nouveaux paramètres de canal.

Les nouveaux paramètres de chaîne sont désormais disponibles sur votre page channels.

Matériels supplémentaires

Voir aussi

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

Rubriques

• Propriétés du canal