Naar inhoud springen

API-integratie

Alle ophaalgegevens zijn beschikbaar via een open HTTP-API. De API vormt de basis van elke integratie – gebruik hem rechtstreeks in je eigen applicaties, scripts of smarthomesystemen.

Eindpunt

Het centrale eindpunt geeft alle ophaaldata voor een adres – gegroepeerd per afvalsoort – terug als JSON. Het is hetzelfde eindpunt dat ook in de openHAB-integratie wordt gebruikt:

POSThttps://binable.app/api/fetch

Methode: POST · Antwoord: JSON · Een API-sleutel is optioneel – anonieme verzoeken zijn mogelijk, maar kunnen strengere rate limits hebben.

Met een API-sleutel krijg je hogere rate limits. Voeg simpelweg de header Authorization: ApiKey <jouw-sleutel> toe. Gratis API-sleutel aanvragen

Adres doorgeven

Het adres kan op drie manieren worden doorgegeven – kies de manier die het beste bij je systeem past.

De volgende velden worden gebruikt: street, houseNumber, zip, city en country (ISO 3166-1 alpha-2-landcode, bijv. DE).

Queryparameters

Voeg de adresvelden toe aan de URL (speciale tekens moeten URL-gecodeerd worden):

https://binable.app/api/fetch?street=Musterstra%C3%9Fe&houseNumber=1a&zip=12345&city=Musterstadt&country=DE

HTTP-headers

Geef het adres door via X-Address-*-headers – zo doet de openHAB-integratie dat ook. Let op: geen speciale tekens in headers, schrijf bijvoorbeeld "ue" in plaats van "ü".

X-Address-Street: Musterstrasse
X-Address-HouseNumber: 1a
X-Address-Zip: 12345
X-Address-City: Musterstadt
X-Address-Country: DE

JSON-body

Verstuur het adres als JSON-object in de body van het verzoek:

{
  "street": "Musterstraße",
  "houseNumber": "1a",
  "zip": "12345",
  "city": "Musterstadt",
  "country": "DE"
}

Voorbeeld: curl-aanroep

Een volledige aanroep met een JSON-body ziet er zo uit:

curl -X POST https://binable.app/api/fetch \
  -H "Content-Type: application/json" \
  -d '{
    "street": "Musterstraße",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Musterstadt",
    "country": "DE"
  }'

Dezelfde aanroep met een API-sleutel:

curl -X POST https://binable.app/api/fetch \
  -H "Authorization: ApiKey <dein-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"street":"Musterstraße","houseNumber":"1a","zip":"12345","city":"Musterstadt","country":"DE"}'

← Overzicht integraties  ·  Volledige API-documentatie