こんにちは、エムケーワイです。
先日投稿した「現在地の天気予報表示」で、OpenWeather社のWeather APIを使って現在地の天気予報データの取得・表示を行いました。記事中でも触れた通り、Weather APIを使用するにはOpenWeather社のWebサイトでアカウントを作成し、APIキーを取得する必要があります。この記事ではその手順について説明します。
1. OpenWeather社Webサイトでのアカウント作成
まずOpenWeather社のWebサイトにアクセスします。
1) OpenWeather社Webサイトへのアクセス
OpwnWeather社のWebサイトにアクセスします。
2) Weather APIの確認
ナビゲーションメニューの「API」をクリックすると下図のようなWeather APIの説明画面が表示されます。
3) API documentationの確認
画面をスクロールすると、各種APIの紹介の下にドキュメント(API documentation)があります。APIの使用方法はここで確認できます。
4) アカウント作成ダイアログの表示
ページの先頭に戻り、本文中の”sign up”をクリックします。
5) アカウントの作成
アカウント作成ダイアログが表示されたら、ユーザー名、メールアドレス、パスワード(2回)を入力し、16歳以上であること、利用規約への同意にチェックを入れます。更に「私はロボットではありません」にもチェックを入れ、”Create Account”をクリックします。
各種お知らせ等のメールを受け取りたい場合は、上記以外のチェックボックスにもチェックを入れます。
6) 使用目的の選択
下図のようなダイアログが表示されるので、使用目的を選択し、”Save”をクリックします。
「現在地の天気予報表示」では、使用目的は”Weather widget for web”を選択しました。また、個人なので「Company」には何も入力しませんでした。
2. Weather APIのAPIキー取得
Weather APIのAPIキーを取得します。
7) メールの確認
5)で登録したメールアドレスに下図のようなメールが届きます。”Verify your email”をクリックします。
8) メールアドレス確認成功メッセージの確認
7)の操作によりブラウザで下図のようなページが開かれ、メールアドレスの確認に成功した旨のメッセージが表示されます。
アカウントが作成されたので、ナビゲーションメニューの「Marketplace」の右に登録したユーザー名が項目として追加され、右端の項目が「Sign inSupport」から「Support」に変わっています。
9) APIキーの確認
“API Keys”をクリックし、発行されたAPIキーを確認します。
Weather APIを使用する際は、このAPIキーが必要になるので、テキストエディタやメモ帳などでコピペして保存しておきましょう！
3. API documentationの確認
APIドキュメントでAPIの使用方法を確認します。
10) Weather API説明画面への移行
ナビゲーションメニューの「API」をクリックします。
11) API documentationの確認
画面をスクロールし、API documentationまで移動します。「現在地の天気予報表示」では”5 day / 3 hour weather forecast”を使用したので、”5 day / 3 hour weather forecast”をクリックします。
12) “5 day / 3 hour weather forecast”の使用方法の確認
“5 day / 3 hour weather forecast”の使用方法を確認します。「現在地の天気予報表示」では緯度と経度で位置を指定しましたが、その指定方法は下図のように記述されています(何故か”units”が2回説明されていますね^_^;)。
＜必須パラメータ＞
| lat | 緯度 |
| lon | 経度 |
| appid | APIキー |
＜オプションパラメータ＞
| units | 気温の単位 standard：ケルビン(°K、デフォルト) metric：摂氏(℃) imperial：華氏(℉) |
| mode | レスポンス・フォーマット デフォルト：JSON xml：xml |
| cnt | レスポンス内のタイムスタンプ数 |
| lang | レスポンス内の一部のデータに適用される言語 |
「現在地の天気予報表示」ではオプションパラメータを下表のように設定しています。
| units | metric |
| mode | 未設定 |
| cnt | 未設定 |
| lang | ja |
位置の指定は緯度と経度(geographic coordinates)以外に都市名(city name)、都市ID(city ID)、郵便番号(ZIP code)でも指定可能です。詳細はAPI documentationをご参照ください。
4. 注意事項
Weather APIを使用するにあたり、いくつかの注意事項が記載されていましたので掲載しておきます。
間違いがあるといけないので全体の日本語訳はしませんが、1点目として、APIを呼び出すのは、ひとつの場所で10分毎に1回以下とするよう記載されています。予報が10分間に1回より多く更新されることはないという事です。ページを訪れてくださった方に注意を促す必要がありますね。
5. まとめ
OpenWeather社のWebサイトからWeather APIを使用するためのAPIキーを取得する方法について説明しました。
アカウントを作成するページへのリンクがナビゲーションメニュー内に見つけられず、探すのに少し苦労しましたが、その後の手続きは、Google Maps APIのAPIキー取得に比べると難しくなかったように思います。
世の中には便利なAPIがあるものですね。「現在地の天気予報表示」では天気と気温しか表示していませんが、天気予報データには他にも湿度や風速など多数のデータが含まれています。また、”5 day / 3 hour weather forecast”以外にも無料で利用できるサービスがあります。ありがたいことです。
本記事を読んで興味を持たれた方は是非「現在地の天気予報表示」も訪れて現在地の天気予報を確認いただければと思います。
最後までお読みいただきありがとうございました。