Entwickler

Entwickeln mit iotBind

Einfache APIs für Mikrocontroller: eine URL, ein Geräteschlüssel und ein paar Parameter.

Geräteschlüssel erhalten API-Referenz

HTTP / HTTPS

Daten mit GET- oder POST-Anfragen und JSON-Antworten senden und lesen.

MQTT

Veröffentlichen und abonnieren über Ihren MQTT.one-Broker für sofortige Befehle.

Webhooks

Signierte Benachrichtigungen auf Ihrem eigenen Server empfangen, wenn etwas passiert.

Schnellstart

  1. 1

    Konto erstellen

    Registrieren Sie sich kostenlos und bestätigen Sie Ihre E-Mail-Adresse.

  2. 2

    Gerät hinzufügen

    Fügen Sie einen Schalter, Sensor, Tank oder Tracker hinzu und öffnen Sie dann das Schlüsselsymbol, um die eindeutige ID und den geheimen Schlüssel zu kopieren.

  3. 3

    Erste Anfrage senden

    Verwenden Sie die Beispiele unten in Ihrem Sketch oder testen Sie sie im Browser.

Grundlagen

Die Basisadresse der API-Version 1 lautet http://api.iotbind.com/v1 (HTTPS wird unterstützt). Jede Anfrage enthält diese Parameter, entweder im Query-String (GET) oder als Formularfelder (POST):

ParameterBeschreibung
method"get" or "post": wie die Parameter gesendet werden. Immer erforderlich.
keyDer geheime API-Schlüssel des Geräts. Immer erforderlich.
uidDie eindeutige ID des Geräts. Immer erforderlich.

Halten Sie den Geräteschlüssel geheim. Falls er bekannt wird, erzeugen Sie über das Schlüsselsymbol des Geräts einen neuen: Der alte Schlüssel funktioniert dann sofort nicht mehr.

Schalter

Einen Schalter ein- oder ausschalten, bis zu drei Werte speichern oder seinen aktuellen Zustand lesen.

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

ParameterBeschreibung
cmd Optionaler Befehl: onoffgetping
data1 Optionaler Text oder optionale Zahl zum Speichern.
data2 Optionaler Text oder optionale Zahl zum Speichern.
data3 Optionaler Text oder optionale Zahl zum Speichern.
Daten senden 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&data1=24.5&data2=OK
Antwort: {"MESSAGE":"UPDATED"}
Gerät auslesen 
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": ""
}

Dieselben Parameter funktionieren als POST-Formularfelder mit method=post · Um zu melden, dass das Gerät verbunden ist, senden Sie cmd=ping → {"MESSAGE":"PING OK"}

Sensoren

Bis zu drei Messwerte speichern oder die neuesten Werte lesen.

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

ParameterBeschreibung
cmd Optionaler Befehl: getping
data1 Optionaler Text oder optionale Zahl zum Speichern.
data2 Optionaler Text oder optionale Zahl zum Speichern.
data3 Optionaler Text oder optionale Zahl zum Speichern.
Daten senden 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&data1=23.4&data2=41&data3=1012
Antwort: {"MESSAGE":"UPDATED"}
Gerät auslesen 
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"
}

Dieselben Parameter funktionieren als POST-Formularfelder mit method=post · Um zu melden, dass das Gerät verbunden ist, senden Sie cmd=ping → {"MESSAGE":"PING OK"}

Flüssigkeitstanks

Füllstand und Temperatur des Tanks speichern, seine Pumpe schalten oder seinen Zustand lesen.

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

ParameterBeschreibung
cmd Optionaler Befehl (schaltet die Tankpumpe): onoffgetping
level Tankfüllstand (Zahl).
temperature Optionale Tanktemperatur (Zahl).
Daten senden 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&level=67&temperature=21
Antwort: {"MESSAGE":"UPDATED"}
Gerät auslesen 
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"
}

Dieselben Parameter funktionieren als POST-Formularfelder mit method=post · Um zu melden, dass das Gerät verbunden ist, senden Sie cmd=ping → {"MESSAGE":"PING OK"}

GPS-Ortung

Eine Position mit bis zu vier Zusatzwerten speichern oder die letzte Position lesen.

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

ParameterBeschreibung
cmd Optionaler Befehl: getping
latitude Breitengrad (Zahl).
longitude Längengrad (Zahl).
data1 Optionaler Text oder optionale Zahl zum Speichern.
data2 Optionaler Text oder optionale Zahl zum Speichern.
data3 Optionaler Text oder optionale Zahl zum Speichern.
data4 Optionaler Text oder optionale Zahl zum Speichern.
Daten senden 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&latitude=24.7136&longitude=46.6753&data1=62
Antwort: {"MESSAGE":"UPDATED"}
Gerät auslesen 
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"
}

Dieselben Parameter funktionieren als POST-Formularfelder mit method=post · Um zu melden, dass das Gerät verbunden ist, senden Sie cmd=ping → {"MESSAGE":"PING OK"}

MQTT

iotBind arbeitet mit dem Dienst MQTT.one: Die Plattform veröffentlicht in Ihren Topics, wenn sich ein Gerät ändert, und Ihre Geräte senden JSON-Nachrichten an iotBind.

  1. Erstellen Sie ein MQTT.one-Konto und legen Sie die benötigten Topics an.
  2. Öffnen Sie in der Plattform „MQTT service“ und verknüpfen Sie Ihr MQTT.one-Konto.
  3. Aktivieren Sie in den Geräteeinstellungen „MQTT publish messages“ und wählen Sie das Topic.
  4. Verbinden Sie Ihr Board mit Ihren MQTT.one-Zugangsdaten mit dem Broker und verwenden Sie die Client-ID iotbind-<UNIQUE_ID>.
  5. Veröffentlichen Sie JSON-Nachrichten im iotbind-Topic, das in Ihrem Konto angezeigt wird.
Nachricht an das Topic iotbind/switch/ 
{ "key": "DEVICE_KEY", "uid": "UNIQUE_ID", "cmd": "off", "data1": "24.5" }

MQTT erfordert einen Tarif mit der MQTT-Funktion und ein Konto bei MQTT.one

Fehlercodes

400Ungültige Anfrage: Adresse, Parameter oder Body sind ungültig.
401Nicht autorisiert: Geräteschlüssel oder eindeutige ID sind falsch.
404Nicht gefunden: Die angeforderte Ressource existiert nicht.
429Zu viele Anfragen: Senden Sie langsamer oder prüfen Sie die Limits Ihres Tarifs.

Ihr nächstes Projekt verdient eine Cloud

Erstellen Sie in einer Minute ein kostenloses Konto und verbinden Sie noch heute Ihr erstes Gerät.

Kostenloses Konto erstellen Sprechen Sie uns an