Dla programistów

Twórz na iotBind

Proste API zaprojektowane dla mikrokontrolerów: jeden URL, klucz urządzenia i kilka parametrów.

Zdobądź klucz urządzenia Dokumentacja API

HTTP / HTTPS

Wysyłaj i odczytuj dane żądaniami GET lub POST z odpowiedziami JSON.

MQTT

Publikuj i subskrybuj przez swojego brokera MQTT.one, by wysyłać polecenia natychmiast.

Webhooki

Otrzymuj podpisane powiadomienia na własnym serwerze, gdy coś się wydarzy.

Szybki start

  1. 1

    Załóż konto

    Zarejestruj się za darmo i potwierdź swój adres e-mail.

  2. 2

    Dodaj urządzenie

    Dodaj przełącznik, czujnik, zbiornik lub lokalizator, a następnie otwórz ikonę klucza, by skopiować unikalny ID i tajny klucz.

  3. 3

    Wyślij pierwsze żądanie

    Użyj poniższych przykładów w swoim szkicu lub przetestuj je w przeglądarce.

Podstawy

Adres bazowy API w wersji 1 to http://api.iotbind.com/v1 (obsługiwany jest HTTPS). Każde żądanie zawiera te parametry, w query stringu (GET) lub jako pola formularza (POST):

ParametrOpis
method"get" lub "post": sposób wysyłania parametrów. Zawsze wymagany.
keyTajny klucz API urządzenia. Zawsze wymagany.
uidUnikalny ID urządzenia. Zawsze wymagany.

Zachowaj klucz urządzenia w tajemnicy. Jeśli wycieknie, wygeneruj nowy za pomocą ikony klucza urządzenia: stary klucz natychmiast przestanie działać.

Przełączniki

Włącz lub wyłącz przełącznik, zapisz do trzech wartości lub odczytaj jego bieżący stan.

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

ParametrOpis
cmd Opcjonalne polecenie: onoffgetping
data1 Opcjonalny tekst lub liczba do zapisania.
data2 Opcjonalny tekst lub liczba do zapisania.
data3 Opcjonalny tekst lub liczba do zapisania.
Wysyłanie danych 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&data1=24.5&data2=OK
Odpowiedź: {"MESSAGE":"UPDATED"}
Odczyt urządzenia 
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": ""
}

Te same parametry działają jako pola formularza POST z method=post · Aby zgłosić, że urządzenie jest połączone, wyślij cmd=ping → {"MESSAGE":"PING OK"}

Czujniki

Zapisz do trzech odczytów lub odczytaj najnowsze wartości.

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

ParametrOpis
cmd Opcjonalne polecenie: getping
data1 Opcjonalny tekst lub liczba do zapisania.
data2 Opcjonalny tekst lub liczba do zapisania.
data3 Opcjonalny tekst lub liczba do zapisania.
Wysyłanie danych 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&data1=23.4&data2=41&data3=1012
Odpowiedź: {"MESSAGE":"UPDATED"}
Odczyt urządzenia 
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"
}

Te same parametry działają jako pola formularza POST z method=post · Aby zgłosić, że urządzenie jest połączone, wyślij cmd=ping → {"MESSAGE":"PING OK"}

Zbiorniki cieczy

Zapisz poziom i temperaturę zbiornika, przełącz pompę lub odczytaj jego stan.

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

ParametrOpis
cmd Opcjonalne polecenie (przełącza pompę zbiornika): onoffgetping
level Poziom w zbiorniku (liczba).
temperature Opcjonalna temperatura zbiornika (liczba).
Wysyłanie danych 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&level=67&temperature=21
Odpowiedź: {"MESSAGE":"UPDATED"}
Odczyt urządzenia 
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"
}

Te same parametry działają jako pola formularza POST z method=post · Aby zgłosić, że urządzenie jest połączone, wyślij cmd=ping → {"MESSAGE":"PING OK"}

Lokalizacja GPS

Zapisz pozycję z maksymalnie czterema dodatkowymi wartościami lub odczytaj najnowszą pozycję.

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

ParametrOpis
cmd Opcjonalne polecenie: getping
latitude Szerokość geograficzna (liczba).
longitude Długość geograficzna (liczba).
data1 Opcjonalny tekst lub liczba do zapisania.
data2 Opcjonalny tekst lub liczba do zapisania.
data3 Opcjonalny tekst lub liczba do zapisania.
data4 Opcjonalny tekst lub liczba do zapisania.
Wysyłanie danych 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&latitude=24.7136&longitude=46.6753&data1=62
Odpowiedź: {"MESSAGE":"UPDATED"}
Odczyt urządzenia 
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"
}

Te same parametry działają jako pola formularza POST z method=post · Aby zgłosić, że urządzenie jest połączone, wyślij cmd=ping → {"MESSAGE":"PING OK"}

MQTT

iotBind współpracuje z usługą MQTT.one: platforma publikuje w Twoich tematach, gdy urządzenie się zmienia, a Twoje urządzenia publikują wiadomości JSON do iotBind.

  1. Załóż konto MQTT.one i dodaj potrzebne tematy.
  2. Na platformie otwórz „Usługa MQTT” i połącz swoje konto MQTT.one.
  3. W ustawieniach urządzenia włącz „Publikuj wiadomości MQTT” i wybierz temat.
  4. Połącz płytkę z brokerem, używając danych MQTT.one i client ID iotbind-<UNIQUE_ID>.
  5. Publikuj wiadomości JSON w temacie iotbind widocznym na Twoim koncie.
Wiadomość do tematu iotbind/switch/ 
{ "key": "DEVICE_KEY", "uid": "UNIQUE_ID", "cmd": "off", "data1": "24.5" }

MQTT wymaga planu z funkcją MQTT oraz konta w MQTT.one

Kody błędów

400Błędne żądanie: adres, parametry lub treść są nieprawidłowe.
401Brak autoryzacji: klucz urządzenia lub unikalny ID są błędne.
404Nie znaleziono: żądany zasób nie istnieje.
429Zbyt wiele żądań: zwolnij lub sprawdź limity swojego planu.

Twój następny projekt zasługuje na chmurę

Załóż darmowe konto w minutę i podłącz swoje pierwsze urządzenie jeszcze dziś.

Załóż darmowe konto Porozmawiaj z nami