Developers

Bouw op iotBind

Eenvoudige API's ontworpen voor microcontrollers: één URL, een apparaatsleutel en een paar parameters.

Haal je apparaatsleutel op API-referentie

HTTP / HTTPS

Verstuur en lees gegevens met GET- of POST-verzoeken en JSON-antwoorden.

MQTT

Publiceer en abonneer via je MQTT.one-broker voor directe commando's.

Webhooks

Ontvang ondertekende meldingen op je eigen server wanneer er iets gebeurt.

Snelstart

  1. 1

    Maak een account aan

    Registreer je gratis en bevestig je e-mailadres.

  2. 2

    Voeg een apparaat toe

    Voeg een schakelaar, sensor, tank of tracker toe en open het sleutelpictogram om de unieke ID en de geheime sleutel te kopiëren.

  3. 3

    Verstuur je eerste verzoek

    Gebruik de voorbeelden hieronder in je sketch of test ze in je browser.

Basis

Het basisadres van API-versie 1 is http://api.iotbind.com/v1 (HTTPS wordt ondersteund). Elk verzoek bevat deze parameters, in de querystring (GET) of als formuliervelden (POST):

ParameterBeschrijving
method"get" of "post": hoe de parameters worden verstuurd. Altijd verplicht.
keyDe geheime API-sleutel van het apparaat. Altijd verplicht.
uidDe unieke ID van het apparaat. Altijd verplicht.

Houd de apparaatsleutel geheim. Is hij uitgelekt, genereer dan een nieuwe via het sleutelpictogram van het apparaat: de oude sleutel werkt direct niet meer.

Schakelaars

Zet een schakelaar aan of uit, sla tot drie waarden op of lees de huidige status.

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

ParameterBeschrijving
cmd Optioneel commando: onoffgetping
data1 Optionele tekst of getal om op te slaan.
data2 Optionele tekst of getal om op te slaan.
data3 Optionele tekst of getal om op te slaan.
Gegevens versturen 
http://api.iotbind.com/v1/switch.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&data1=24.5&data2=OK
Antwoord: {"MESSAGE":"UPDATED"}
Apparaat uitlezen 
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": ""
}

Dezelfde parameters werken als POST-formuliervelden met method=post · Om te melden dat het apparaat verbonden is, verstuur cmd=ping → {"MESSAGE":"PING OK"}

Sensoren

Sla tot drie metingen op of lees de laatste waarden.

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

ParameterBeschrijving
cmd Optioneel commando: getping
data1 Optionele tekst of getal om op te slaan.
data2 Optionele tekst of getal om op te slaan.
data3 Optionele tekst of getal om op te slaan.
Gegevens versturen 
http://api.iotbind.com/v1/sensor.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&data1=23.4&data2=41&data3=1012
Antwoord: {"MESSAGE":"UPDATED"}
Apparaat uitlezen 
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"
}

Dezelfde parameters werken als POST-formuliervelden met method=post · Om te melden dat het apparaat verbonden is, verstuur cmd=ping → {"MESSAGE":"PING OK"}

Vloeistoftanks

Sla het niveau en de temperatuur van de tank op, schakel de pomp of lees de status.

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

ParameterBeschrijving
cmd Optioneel commando (schakelt de pomp van de tank): onoffgetping
level Tankniveau (getal).
temperature Optionele tanktemperatuur (getal).
Gegevens versturen 
http://api.iotbind.com/v1/tank.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&cmd=on&level=67&temperature=21
Antwoord: {"MESSAGE":"UPDATED"}
Apparaat uitlezen 
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"
}

Dezelfde parameters werken als POST-formuliervelden met method=post · Om te melden dat het apparaat verbonden is, verstuur cmd=ping → {"MESSAGE":"PING OK"}

GPS-tracking

Sla een positie op met tot vier extra waarden of lees de laatste positie.

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

ParameterBeschrijving
cmd Optioneel commando: getping
latitude Breedtegraad (getal).
longitude Lengtegraad (getal).
data1 Optionele tekst of getal om op te slaan.
data2 Optionele tekst of getal om op te slaan.
data3 Optionele tekst of getal om op te slaan.
data4 Optionele tekst of getal om op te slaan.
Gegevens versturen 
http://api.iotbind.com/v1/tracking.php?method=get&key=DEVICE_KEY&uid=UNIQUE_ID&latitude=24.7136&longitude=46.6753&data1=62
Antwoord: {"MESSAGE":"UPDATED"}
Apparaat uitlezen 
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"
}

Dezelfde parameters werken als POST-formuliervelden met method=post · Om te melden dat het apparaat verbonden is, verstuur cmd=ping → {"MESSAGE":"PING OK"}

MQTT

iotBind werkt met de dienst MQTT.one: het platform publiceert naar je topics wanneer een apparaat verandert, en je apparaten publiceren JSON-berichten naar iotBind.

  1. Maak een MQTT.one-account aan en voeg de topics toe die je nodig hebt.
  2. Open in het platform "MQTT-dienst" en koppel je MQTT.one-account.
  3. Schakel in de apparaatinstellingen "MQTT-berichten publiceren" in en kies het topic.
  4. Verbind je board met de broker met je MQTT.one-gegevens, met de client-ID iotbind-<UNIQUE_ID>.
  5. Publiceer JSON-berichten naar het iotbind-topic dat in je account wordt getoond.
Bericht naar het topic iotbind/switch/ 
{ "key": "DEVICE_KEY", "uid": "UNIQUE_ID", "cmd": "off", "data1": "24.5" }

MQTT vereist een abonnement met de MQTT-functie en een account bij MQTT.one

Foutcodes

400Ongeldig verzoek: het adres, de parameters of de body zijn niet geldig.
401Niet geautoriseerd: de apparaatsleutel of unieke ID is onjuist.
404Niet gevonden: de gevraagde bron bestaat niet.
429Te veel verzoeken: vertraag of controleer de limieten van je abonnement.

Je volgende project verdient een cloud

Maak in een minuut een gratis account aan en verbind vandaag nog je eerste apparaat.

Gratis account aanmaken Neem contact op