API-samþætting
Öll sorphirðugögn eru aðgengileg í gegnum opið HTTP-API. API-ið er grunnurinn að öllum samþættingum – notaðu það beint í þínum eigin forritum, skriftum eða snjallheimiliskerfum.
Endapunktur
Aðalendapunkturinn skilar öllum sorphirðudögum fyrir heimilisfang, flokkuðum eftir úrgangsflokki, sem JSON. Þetta er sami endapunktur og notaður er í openHAB-samþættingunni:
POSThttps://binable.app/api/fetch
Aðferð: POST · Svar: JSON · API-lykill er valfrjáls – nafnlausar beiðnir eru mögulegar en geta verið takmarkaðar strangar.
Heimilisfangið sent
Hægt er að senda heimilisfangið á þrjá mismunandi vegu – veldu þann sem hentar kerfinu þínu best.
Eftirfarandi reitir eru notaðir: street, houseNumber, zip, city og country (landskóði samkvæmt ISO 3166-1 alpha-2, t.d. DE).
Fyrirspurnarbreytur
Bættu heimilisfangsreitunum aftan við slóðina (sérstafi á borð við ü eða þ þarf að URL-kóða):
https://binable.app/api/fetch?street=Musterstra%C3%9Fe&houseNumber=1a&zip=12345&city=Musterstadt&country=DE
HTTP-hausar
Sendu heimilisfangið í X-Address-* hausum – það er það sem openHAB-samþættingin notar. Athugið: engir sérstafir í hausum, skrifaðu „ue“ í stað „ü“.
X-Address-Street: Musterstrasse
X-Address-HouseNumber: 1a
X-Address-Zip: 12345
X-Address-City: Musterstadt
X-Address-Country: DE
JSON-meginmál
Sendu heimilisfangið sem JSON-hlut í meginmáli beiðnarinnar:
{
"street": "Musterstraße",
"houseNumber": "1a",
"zip": "12345",
"city": "Musterstadt",
"country": "DE"
}
Dæmi: curl-kall
Fullt kall með JSON-meginmáli lítur svona út:
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"
}'
Sama kall með API-lykli:
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"}'
Gæti líka vakið áhuga
← Yfirlit yfir samþættingar · Öll API-skjölunin (opnast í nýjum flipa)