Разработчикам

Создавайте на iotBind

Простые API, созданные для микроконтроллеров: один URL, ключ устройства и несколько параметров.

Получить ключ устройства Справочник API

HTTP / HTTPS

Отправляйте и читайте данные запросами GET или POST с ответами в JSON.

MQTT

Публикуйте сообщения и подписывайтесь через ваш брокер MQTT.one для мгновенных команд.

Webhooks

Получайте подписанные уведомления на свой сервер, когда что-то происходит.

Быстрый старт

  1. 1

    Создайте аккаунт

    Зарегистрируйтесь бесплатно и подтвердите адрес электронной почты.

  2. 2

    Добавьте устройство

    Добавьте выключатель, датчик, бак или трекер, затем нажмите на значок ключа, чтобы скопировать уникальный ID и секретный ключ.

  3. 3

    Отправьте первый запрос

    Используйте примеры ниже в своём скетче или проверьте их в браузере.

Основы

Базовый адрес API версии 1: http://api.iotbind.com/v1 (поддерживается HTTPS). Каждый запрос содержит следующие параметры — в строке запроса (GET) или в полях формы (POST):

ПараметрОписание
method"get" or "post": способ передачи параметров. Обязателен всегда.
keyСекретный API-ключ устройства. Обязателен всегда.
uidУникальный ID устройства. Обязателен всегда.

Держите ключ устройства в секрете. Если он утёк, создайте новый через значок ключа устройства: старый ключ сразу перестанет работать.

Выключатели

Включайте или выключайте выключатель, сохраняйте до трёх значений или читайте его текущее состояние.

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

ПараметрОписание
cmd Необязательная команда: onoffgetping
data1 Необязательный текст или число для сохранения.
data2 Необязательный текст или число для сохранения.
data3 Необязательный текст или число для сохранения.
Отправка данных 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&data1=24.5&data2=OK
Ответ: {"MESSAGE":"UPDATED"}
Чтение устройства 
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": ""
}

Те же параметры работают как поля формы POST с method=post · Чтобы сообщить, что устройство на связи, отправьте cmd=ping → {"MESSAGE":"PING OK"}

Датчики

Сохраняйте до трёх показаний или читайте последние значения.

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

ПараметрОписание
cmd Необязательная команда: getping
data1 Необязательный текст или число для сохранения.
data2 Необязательный текст или число для сохранения.
data3 Необязательный текст или число для сохранения.
Отправка данных 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&data1=23.4&data2=41&data3=1012
Ответ: {"MESSAGE":"UPDATED"}
Чтение устройства 
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"
}

Те же параметры работают как поля формы POST с method=post · Чтобы сообщить, что устройство на связи, отправьте cmd=ping → {"MESSAGE":"PING OK"}

Баки с жидкостью

Сохраняйте уровень и температуру в баке, переключайте насос или читайте состояние.

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

ПараметрОписание
cmd Необязательная команда (переключает насос бака): onoffgetping
level Уровень в баке (число).
temperature Необязательная температура в баке (число).
Отправка данных 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&level=67&temperature=21
Ответ: {"MESSAGE":"UPDATED"}
Чтение устройства 
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"
}

Те же параметры работают как поля формы POST с method=post · Чтобы сообщить, что устройство на связи, отправьте cmd=ping → {"MESSAGE":"PING OK"}

GPS-трекинг

Сохраняйте местоположение с четырьмя дополнительными значениями или читайте последнее местоположение.

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

ПараметрОписание
cmd Необязательная команда: getping
latitude Широта (число).
longitude Долгота (число).
data1 Необязательный текст или число для сохранения.
data2 Необязательный текст или число для сохранения.
data3 Необязательный текст или число для сохранения.
data4 Необязательный текст или число для сохранения.
Отправка данных 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&latitude=24.7136&longitude=46.6753&data1=62
Ответ: {"MESSAGE":"UPDATED"}
Чтение устройства 
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"
}

Те же параметры работают как поля формы POST с method=post · Чтобы сообщить, что устройство на связи, отправьте cmd=ping → {"MESSAGE":"PING OK"}

MQTT

iotBind работает с сервисом MQTT.one: платформа публикует сообщения в ваши топики при изменении устройства, а ваши устройства публикуют JSON-сообщения в iotBind.

  1. Создайте аккаунт MQTT.one и добавьте нужные топики.
  2. На платформе откройте «Сервис MQTT» и привяжите аккаунт MQTT.one.
  3. В настройках устройства включите «Публикация MQTT-сообщений» и выберите топик.
  4. Подключите плату к брокеру с данными MQTT.one, используя client ID iotbind-<UNIQUE_ID>.
  5. Публикуйте JSON-сообщения в топик iotbind, указанный в вашем аккаунте.
Сообщение в топик iotbind/switch/ 
{ "key": "DEVICE_KEY", "uid": "UNIQUE_ID", "cmd": "off", "data1": "24.5" }

Для MQTT нужен тариф с поддержкой MQTT и аккаунт на MQTT.one

Коды ошибок

400Неверный запрос: адрес, параметры или тело запроса недопустимы.
401Не авторизован: неверный ключ устройства или уникальный ID.
404Не найдено: запрошенный ресурс не существует.
429Слишком много запросов: снизьте частоту или проверьте лимиты тарифа.

Ваш следующий проект заслуживает облака

Создайте бесплатный аккаунт за минуту и подключите первое устройство уже сегодня.

Создать бесплатный аккаунт Связаться с нами