Przejdź do treści

Integracja z API

Wszystkie dane o odbiorze odpadów są dostępne przez otwarte API HTTP. API jest podstawą każdej integracji – korzystaj z niego bezpośrednio we własnych aplikacjach, skryptach lub systemach smart home.

Punkt końcowy

Centralny punkt końcowy zwraca wszystkie terminy odbioru dla adresu, pogrupowane według rodzaju odpadów, w formacie JSON. Jest to ten sam punkt końcowy, który jest używany w integracji z openHAB:

POSThttps://binable.app/api/fetch

Metoda: POST · Odpowiedź: JSON · Klucz API jest opcjonalny – zapytania anonimowe są możliwe, ale mogą podlegać surowszym limitom.

Z kluczem API otrzymujesz wyższe limity. Wystarczy dodać nagłówek Authorization: ApiKey <twój-klucz>. Uzyskaj darmowy klucz API

Przekazywanie adresu

Adres można przekazać na trzy różne sposoby – wybierz ten, który najlepiej pasuje do Twojego systemu.

Używane są następujące pola: street, houseNumber, zip, city oraz country (kod kraju ISO 3166-1 alpha-2, np. DE).

Parametry zapytania

Dołącz pola adresu do adresu URL (znaki specjalne muszą być zakodowane w URL):

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

Nagłówki HTTP

Przekaż adres za pomocą nagłówków X-Address-* – tak robi to integracja z openHAB. Uwaga: bez znaków specjalnych w nagłówkach, wpisz np. "ue" zamiast "ü".

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

Treść JSON

Wyślij adres jako obiekt JSON w treści żądania:

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

Przykład: wywołanie curl

Pełne wywołanie z treścią JSON wygląda następująco:

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"
  }'

To samo wywołanie z kluczem API:

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"}'

← Przegląd integracji  ·  Pełna dokumentacja API