Développeurs

Développez avec iotBind

Des API simples conçues pour les microcontrôleurs : une URL, une clé d'appareil et quelques paramètres.

Obtenir votre clé d'appareil Référence de l'API

HTTP / HTTPS

Envoyez et lisez des données avec des requêtes GET ou POST et des réponses JSON.

MQTT

Publiez et abonnez-vous via votre broker MQTT.one pour des commandes instantanées.

Webhooks

Recevez des notifications signées sur votre propre serveur lorsqu'un événement se produit.

Démarrage rapide

  1. 1

    Créez un compte

    Inscrivez-vous gratuitement et confirmez votre adresse e-mail.

  2. 2

    Ajoutez un appareil

    Ajoutez un interrupteur, un capteur, un réservoir ou un traceur, puis ouvrez son icône de clé pour copier l'identifiant unique et la clé secrète.

  3. 3

    Envoyez votre première requête

    Utilisez les exemples ci-dessous dans votre sketch ou testez-les dans votre navigateur.

Principes de base

L'adresse de base de la version 1 de l'API est http://api.iotbind.com/v1 (HTTPS est pris en charge). Chaque requête contient ces paramètres, soit dans la chaîne de requête (GET), soit sous forme de champs de formulaire (POST) :

ParamètreDescription
method"get" or "post" : la manière dont les paramètres sont envoyés. Toujours obligatoire.
keyLa clé API secrète de l'appareil. Toujours obligatoire.
uidL'identifiant unique de l'appareil. Toujours obligatoire.

Gardez la clé de l'appareil secrète. En cas de fuite, générez-en une nouvelle depuis l'icône de clé de l'appareil : l'ancienne clé cesse immédiatement de fonctionner.

Interrupteurs

Allumez ou éteignez un interrupteur, enregistrez jusqu'à trois valeurs ou lisez son état actuel.

GET | POST http://api.iotbind.com/v1/switch.php

ParamètreDescription
cmd Commande facultative : onoffgetping
data1 Texte ou nombre facultatif à enregistrer.
data2 Texte ou nombre facultatif à enregistrer.
data3 Texte ou nombre facultatif à enregistrer.
Envoyer des données 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&data1=24.5&data2=OK
Réponse : {"MESSAGE":"UPDATED"}
Lire l'appareil 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=get
{
  "uid": "UNIQUE_ID", "name": "Living room", "type": "RGB Light", "cmd": "on",
  "data1": "24.5", "data1_unit": "C", "data2": "OK", "data2_unit": "", "data3": "", "data3_unit": ""
}

Les mêmes paramètres fonctionnent comme champs de formulaire POST avec method=post · Pour signaler que l'appareil est connecté, envoyez cmd=ping → {"MESSAGE":"PING OK"}

Capteurs

Enregistrez jusqu'à trois mesures ou lisez les dernières valeurs.

GET | POST http://api.iotbind.com/v1/sensor.php

ParamètreDescription
cmd Commande facultative : getping
data1 Texte ou nombre facultatif à enregistrer.
data2 Texte ou nombre facultatif à enregistrer.
data3 Texte ou nombre facultatif à enregistrer.
Envoyer des données 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&data1=23.4&data2=41&data3=1012
Réponse : {"MESSAGE":"UPDATED"}
Lire l'appareil 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=get
{
  "uid": "UNIQUE_ID", "name": "Greenhouse", "type": "Temperature",
  "data1": "23.4", "data1_unit": "C", "data2": "41", "data2_unit": "%", "data3": "1012", "data3_unit": "hPa"
}

Les mêmes paramètres fonctionnent comme champs de formulaire POST avec method=post · Pour signaler que l'appareil est connecté, envoyez cmd=ping → {"MESSAGE":"PING OK"}

Réservoirs de liquide

Enregistrez le niveau et la température du réservoir, commandez sa pompe ou lisez son état.

GET | POST http://api.iotbind.com/v1/tank.php

ParamètreDescription
cmd Commande facultative (commande la pompe du réservoir) : onoffgetping
level Niveau du réservoir (nombre).
temperature Température du réservoir, facultative (nombre).
Envoyer des données 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&level=67&temperature=21
Réponse : {"MESSAGE":"UPDATED"}
Lire l'appareil 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=get
{
  "uid": "UNIQUE_ID", "name": "Roof tank", "type": "Water Level", "cmd": "on",
  "level": "67", "level_unit": "%", "temperature": "21", "temperature_unit": "C"
}

Les mêmes paramètres fonctionnent comme champs de formulaire POST avec method=post · Pour signaler que l'appareil est connecté, envoyez cmd=ping → {"MESSAGE":"PING OK"}

Suivi GPS

Enregistrez une position avec jusqu'à quatre valeurs supplémentaires ou lisez la dernière position.

GET | POST http://api.iotbind.com/v1/tracking.php

ParamètreDescription
cmd Commande facultative : getping
latitude Latitude (nombre).
longitude Longitude (nombre).
data1 Texte ou nombre facultatif à enregistrer.
data2 Texte ou nombre facultatif à enregistrer.
data3 Texte ou nombre facultatif à enregistrer.
data4 Texte ou nombre facultatif à enregistrer.
Envoyer des données 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&latitude=24.7136&longitude=46.6753&data1=62
Réponse : {"MESSAGE":"UPDATED"}
Lire l'appareil 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=get
{
  "uid": "UNIQUE_ID", "name": "Car", "type": "GPS tracking",
  "latitude": "24.7136", "longitude": "46.6753", "data1": "62", "data1_unit": "km/h"
}

Les mêmes paramètres fonctionnent comme champs de formulaire POST avec method=post · Pour signaler que l'appareil est connecté, envoyez cmd=ping → {"MESSAGE":"PING OK"}

MQTT

iotBind fonctionne avec le service MQTT.one : la plateforme publie sur vos topics lorsqu'un appareil change, et vos appareils publient des messages JSON vers iotBind.

  1. Créez un compte MQTT.one et ajoutez les topics dont vous avez besoin.
  2. Dans la plateforme, ouvrez « MQTT service » et associez votre compte MQTT.one.
  3. Dans les paramètres de l'appareil, activez « MQTT publish messages » et choisissez son topic.
  4. Connectez votre carte au broker avec vos identifiants MQTT.one, en utilisant l'ID client iotbind-<UNIQUE_ID>.
  5. Publiez des messages JSON sur le topic iotbind indiqué dans votre compte.
Message vers le topic iotbind/switch/ 
{ "key": "DEVICE_KEY", "uid": "UNIQUE_ID", "cmd": "off", "data1": "24.5" }

MQTT nécessite une offre incluant la fonctionnalité MQTT et un compte sur MQTT.one

Codes d'erreur

400Requête invalide : l'adresse, les paramètres ou le corps ne sont pas valides.
401Non autorisé : la clé de l'appareil ou l'identifiant unique est incorrect.
404Introuvable : la ressource demandée n'existe pas.
429Trop de requêtes : ralentissez ou vérifiez les limites de votre offre.

Votre prochain projet mérite un cloud

Créez un compte gratuit en une minute et connectez votre premier appareil dès aujourd'hui.

Créer un compte gratuit Nous contacter