Aller au contenu

Intégration API

Toutes les données de collecte sont disponibles via une API HTTP ouverte. L'API est la base de chaque intégration – utilisez-la directement dans vos propres applications, scripts ou systèmes domotiques.

Point de terminaison

Le point de terminaison central renvoie toutes les dates de collecte pour une adresse, regroupées par type de déchet, au format JSON. C'est le même point de terminaison que celui utilisé dans l'intégration openHAB :

POSThttps://binable.app/api/fetch

Méthode : POST · Réponse : JSON · Une clé API est facultative – les requêtes anonymes sont possibles mais peuvent être soumises à des limites de débit plus strictes.

Avec une clé API, vous bénéficiez de limites de débit plus élevées. Ajoutez simplement l'en-tête Authorization: ApiKey <votre-clé>. Obtenir une clé API gratuite

Transmettre l''adresse

L'adresse peut être transmise de trois manières différentes – choisissez celle qui convient le mieux à votre système.

Les champs suivants sont utilisés : street, houseNumber, zip, city et country (code pays ISO 3166-1 alpha-2, p. ex. DE).

Paramètres de requête

Ajoutez les champs d'adresse à l'URL (les caractères spéciaux/accentués doivent être encodés pour l'URL) :

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

En-têtes HTTP

Transmettez l'adresse via les en-têtes X-Address-* – c'est ce qu'utilise l'intégration openHAB. Remarque : pas de caractères spéciaux dans les en-têtes, écrivez par exemple "ue" au lieu de "ü".

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

Corps JSON

Envoyez l'adresse sous forme d'objet JSON dans le corps de la requête :

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

Exemple : appel curl

Un appel complet avec un corps JSON ressemble à ceci :

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

Le même appel avec une clé 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"}'

← Aperçu des intégrations  ·  Documentation API complète