API-integrasjon
Alle tømmedata er tilgjengelige via et åpent HTTP-API. API-et er grunnlaget for alle integrasjoner – bruk det direkte i dine egne applikasjoner, skript eller smarthussystemer.
Endepunkt
Det sentrale endepunktet returnerer alle tømmedatoer for en adresse gruppert etter avfallstype som JSON. Det er det samme endepunktet som brukes i openHAB-integrasjonen:
POSThttps://binable.app/api/fetch
Metode: POST · Svar: JSON · En API-nøkkel er valgfri – anonyme forespørsler er mulige, men kan ha strengere begrensninger.
Overføre adressen
Adressen kan overføres på tre ulike måter – velg den som passer best for systemet ditt.
Følgende felter brukes: street, houseNumber, zip, city og country (landskode etter ISO 3166-1 alpha-2, f.eks. DE).
Query-parametere
Legg til adressefeltene i URL-en (æ, ø, å og andre spesialtegn må URL-kodes):
https://binable.app/api/fetch?street=Musterstra%C3%9Fe&houseNumber=1a&zip=12345&city=Musterstadt&country=DE
HTTP-headere
Overfør adressen via X-Address-*-headere – det er dette openHAB-integrasjonen bruker. Merk: ingen spesialtegn i headere, skriv f.eks. «ue» i stedet for «ü».
X-Address-Street: Musterstrasse
X-Address-HouseNumber: 1a
X-Address-Zip: 12345
X-Address-City: Musterstadt
X-Address-Country: DE
JSON-body
Send adressen som et JSON-objekt i forespørselens body:
{
"street": "Musterstraße",
"houseNumber": "1a",
"zip": "12345",
"city": "Musterstadt",
"country": "DE"
}
Eksempel: curl-kall
Et komplett kall med JSON-body ser slik ut:
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"
}'
Det samme kallet med en API-nøkkel:
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"}'
Kanskje også interessant
← Oversikt over integrasjoner · Fullstendig API-dokumentasjon (åpnes i ny fane)