モバイラーズオアシスAPI
(2013/08/14 08:35)モバイラーズオアシスのデータを利用したWEBサイトやアプリケーションを開発できるようにAPIを提供しております。
(以前提供していたv0 APIは提供を終了しました。パラメタや処理速度が改善されたv1 APIを提供しておりますので、こちらをご利用ください)
モバイラーズオアシス 電源情報API v1
概要
このAPIは、モバイラーズオアシスに寄せられた電源の使えるお店情報を取得します。
エンドポイント
http://oasis.mogya.com/api/v1/spots.json
パラメータ
n,s,w,e
北端南端東端西端の緯度経度(必須)latitude,longitude
中心点の緯度経度。省略した場合は、n,w,s,eの中心点が使われます。(v0のときはlat,lngを付けないとdistanceが計算されませんでしたが、v1では常にdistanceが付加されて、距離でソートされた結果が返されます)
tags タグ情報
これを使って、検索するお店の種類を絞り込みます。- 「電源:お客様用コンセント」: お客様用コンセントが用意されているお店/ホームページなどで、電源を利用していい旨が表明されているお店
- 「電源:壁コンセント」: お客様用ではないんだけど、店員さんに聞いたら壁コンセントなどを使う許可をもらえたことのあるお店
- 「電源:USB」: マクドナルドやタリーズなど、電源コンセントじゃなくてUSBケーブルを刺すコンセント(USBポート)が用意されているお店
- 「Qi」: 非接触充電「Qi(おくだけ充電)」充電器設置店舗
categories カテゴリ
これを使って、検索するお店の種類を絞り込みます。「マクドナルド」「喫茶店」などが使えます。カンマで区切って複数のキーワードを列挙できます。複数指定した場合、いずれかのパラメータに合致するものが出力されます
wireless 無線LAN
これを使って、検索するお店の種類を絞り込みます。 「Tullys Wi-Fi」「ソフトバンクWi-Fi」などが使えます。 カンマで区切って複数のキーワードを列挙できます。複数指定した場合、いずれかのパラメータに合致するものが出力されますtags, categories, wireless一つ一つはOR検索ですが、全体としてはAND検索です。例えば tags=電源:お客様用コンセント&wireless=au Wi-Fi,ソフトバンクWi-Fi と指定すると、「ソフトバンクWiFiまたはau WiFiが使えて、電源の使えるお店」リストが返ります
「ソフトバンクWiFiとau WiFi両方が使えるお店」のような検索はできません
レスポンス
status
- "OK" エラーが発生せず、正常に処理が完了した
- "ZERO_RESULTS" 正常に処理が行われたが、指定された条件では返すべきデータが存在しない
- "OVER_QUERY_LIMIT" リクエストが割り当て量を超えている(未使用)
- "REQUEST_DENIED" リクエストが拒否された(未使用)
- "TOO_MUCH_SPOTS" 検索結果が多すぎる。日本全国みたいな広すぎるパラメタを指定したときに戻ってきます。範囲を狭めて試してみてください
- "INVALID_REQUEST" 渡された引数が不足している、不適切。
message
状況に応じて、statusの他にmessageが付加されることがあります。 これはAPIを呼び出したプログラマ向けの簡単なメッセージで、エラーの原因となったパラメタ名などが記載されていることがあります。 注意)messageはデバッグ時に原因を突き止める目的で人間が読むことを想定して提供されているもので、messageを用いて処理を分岐させるべきではありません。messageの内容は連絡なしに変更されることがあります。
results
スポット情報の配列です。
スポット情報
- id:モバイラーズオアシス内でユニークなIDです。
- title:店名
- address:住所
- tel:電話番号
- latitude:緯度
- longitude:経度
- url:店舗公式サイトのURL
- wireless:無線LAN(配列)
- categories:カテゴリ(配列)
- name: カテゴリ名
- image: イメージアイコンのURL
- importance: カテゴリの重要度。1が最低で、大きいほど重要度の高い(具体的な)カテゴリです
- parent_id: カテゴリに親子関係がある場合の親カテゴリID
- tags:電源、Qi、禁煙喫煙などの情報(配列)
- other:その他店舗に関する情報(HTML)
- mo_url:モバイラーズオアシスでの情報ページURL
- distance;latitude,longitudeで指定した緯度経度からのおおよその距離。km単位です。なお、スポット情報はこの距離が近い順でソートされています。
スポット情報を表示する場合、mo_urlのURL宛にリンクを貼ってください(必須) 上記URLには、APIでは取得できないユーザーからのコメントや電源位置に関する詳細情報などが掲載されています。 ユーザーさんはこのページを見ることで、具体的な電源の位置やお店の情報を取得できるようになります。
例
大阪梅田駅周辺で、公式に電源を使えるスポット一覧を取得
v0からの主な変更点
- API名の変更
- パラメータtag: 複数列挙可能なtagsになりました
- パラメータtag: 電源の扱いに関わるタグ名が変更になりました
- lat,lngを指定しなくても、常に結果が中心点からの距離でソートされるようになりました
- 戻ってくるスポット情報の変更
- タグ、無線LANは配列で出力されるようになりました。これにともなって、キーワードもtags,categoreisに変更されています
- カテゴリはオブジェクトの配列で出力されるようになりました。
- entry_idはidに変更されました
APIの利用について
- いずれのAPIも、商用に利用できません。
有償利用のご契約(30,000円/月)をいただいた会社様には個別にAPIを提供させていただいておりますので、お気軽にお問い合わせくださいませ。 - 無償利用のAPIは、予告なく提供を終了する場合があります。
パパぱふぅ (2020/03/02 18:26)
admin (2020/03/01 21:56)
admin (2020/02/29 20:46)
パパぱふぅ (2020/02/26 17:16)
| ||
- モバイラーズオアシスAPI(古い記事) (2020/03/01 20:34)
- NaviCon連携に対応 カーナビに情報が転送できます (2014/03/13 21:53)
- 電源利用席を明記してくれるお店が続々 (2013/12/23 04:55)
- 写真が投稿できるようになりました (2013/12/19 14:35)
- モバイラーズオアシスAPI (2013/08/14 08:35)