Vai al contenuto

Integrazione API

Tutti i dati di raccolta sono disponibili tramite un'API HTTP aperta. L'API è la base di ogni integrazione – utilizzala direttamente nelle tue applicazioni, script o sistemi Smart Home.

Endpoint

L'endpoint centrale restituisce tutte le date di raccolta per un indirizzo – raggruppate per tipo di rifiuto – in formato JSON. È lo stesso endpoint utilizzato anche nell'integrazione openHAB:

POSThttps://binable.app/api/fetch

Metodo: POST · Risposta: JSON · Una chiave API è facoltativa – le richieste anonime sono possibili, ma possono essere soggette a limiti di frequenza più severi.

Con una chiave API ottieni limiti di frequenza più alti. Basta aggiungere l'header Authorization: ApiKey <la-tua-chiave>. Richiedi una chiave API gratuita

Trasmettere l'indirizzo

L'indirizzo può essere trasmesso in tre modi diversi – scegli quello più adatto al tuo sistema.

Vengono utilizzati i seguenti campi: street, houseNumber, zip, city e country (codice paese ISO 3166-1 alpha-2, ad es. DE).

Parametri di query

Aggiungi i campi dell'indirizzo all'URL (i caratteri speciali devono essere codificati per URL):

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

Header HTTP

Trasmetti l'indirizzo tramite gli header X-Address-* – come fa anche l'integrazione openHAB. Nota: nessun carattere speciale negli header, scrivi ad es. "ue" invece di "ü".

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

Body JSON

Invia l'indirizzo come oggetto JSON nel body della richiesta:

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

Esempio: chiamata curl

Una chiamata completa con body JSON è la seguente:

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

La stessa chiamata con chiave 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"}'

← Panoramica delle integrazioni  ·  Documentazione API completa