API entegrasyonu

Tüm toplama verileri açık bir HTTP API üzerinden kullanılabilir. API her entegrasyonun temelidir – onu doğrudan kendi uygulamalarınızda, betiklerinizde veya akıllı ev sistemlerinizde kullanın.

Uç nokta

Merkezi uç nokta, bir adresin tüm toplama tarihlerini – çöp türüne göre gruplanmış – JSON olarak döndürür. openHAB entegrasyonunda kullanılan uç noktanın aynısıdır:

POSThttps://binable.app/api/fetch

Yöntem: POST · Yanıt: JSON · API anahtarı isteğe bağlıdır – anonim istekler mümkündür, ancak duruma göre daha katı hız limitlerine tabidir.

Bir API anahtarıyla daha yüksek hız limitleri elde edersiniz. Bunun için yalnızca Authorization: ApiKey <anahtarınız> başlığını ekleyin. Ücretsiz API anahtarı iste

Adresi iletin

Adres üç farklı şekilde iletilebilir – sisteminize en uygun olanı seçin.

Aşağıdaki alanlar kullanılır: street, houseNumber, zip, city ve country (ISO-3166-1-alpha-2 ülke kodu, ör. DE).

Query parametreleri

Adres alanlarını URL'ye ekleyin (Almanca özel karakterler URL kodlanmalıdır):

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

HTTP başlıkları

Adresi X-Address-* başlıkları üzerinden iletin – openHAB entegrasyonu da böyle yapar. Not: Başlıklarda Almanca özel karakter kullanmayın, örneğin "ü" yerine "ue" yazın.

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

JSON gövdesi

Adresi istek gövdesinde JSON nesnesi olarak gönderin:

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

Örnek: curl çağrısı

JSON gövdeli tam bir çağrı şöyle görünür:

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

API anahtarlı aynı çağrı:

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

← Entegrasyonlara genel bakış · Tam API dokümantasyonu (yeni sekmede açılır)