コンテンツへスキップ

API 連携

すべてのごみ収集データは、オープンな HTTP API で利用できます。API はあらゆる連携の基盤です。独自のアプリケーション、スクリプト、スマートホームシステムで直接ご利用ください。


エンドポイント

中心となるエンドポイントは、住所に対するすべての収集日をごみの種類ごとにまとめて JSON で返します。openHAB 連携で使われているものと同じエンドポイントです:

POSThttps://binable.app/api/fetch

メソッド:POST・レスポンス:JSON・API キーは任意です。匿名でのリクエストも可能ですが、より厳しいレート制限がかかる場合があります。

API キーを使うと、より高いレート制限が適用されます。ヘッダー Authorization: ApiKey <your-key> を追加するだけです。 無料の API キーを取得

住所の渡し方

住所は 3 通りの方法で渡せます。お使いのシステムに最適な方法をお選びください。

使用するフィールドは street、houseNumber、zip、city、country(ISO 3166-1 alpha-2 の国コード、例:DE)です。

クエリパラメーター

住所のフィールドを URL に追加します(ウムラウトや特殊文字は URL エンコードが必要です):

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

HTTP ヘッダー

X-Address-* ヘッダーで住所を渡します。openHAB 連携ではこの方法を使っています。ご注意:ヘッダーにはウムラウトや特殊文字を使えないため、「ü」の代わりに「ue」と記述してください。

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

JSON ボディ

リクエストボディに住所を JSON オブジェクトとして送信します:

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

例:curl での呼び出し

JSON ボディを使った呼び出しの全体は次のとおりです:

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 キーを使った同じ呼び出し:

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

← 連携機能の一覧  ·  API ドキュメント全文 (新しいタブで開きます)