読者です 読者をやめる 読者になる 読者になる

プログラミングノート

プログラミングの備忘録です

Google APIを使用するための設定(APIキーの作成) 第3回

Google API

 アプリケーションがGoogle APIとやり取りするために認証が必要です。

 ブログなど公開されたデータを使うアプリケーションの場合は、APIキーを使って認証することができます。APIキーを使う認証は、APIキーによりプロジェクトを識別します。

  今回は、①APIキーの作成と②APIキー使用の注意について書きます。

 

APIキーを作成する前に

 APIコンソールで、①プロジェクトの作成と②使用するAPIの設定を行った後、APIキーを作成します。

 

1.プロジェクトの作成

Google APIを使用するための設定(プロジェクトの作成 ・ 使用するAPIの設定) 第1回 - プログラミングノートの「1.プロジェクトを作成」をご覧ください。

 

2.使用するAPIの設定

Google APIを使用するための設定(プロジェクトの作成 ・ 使用するAPIの設定) 第1回 - プログラミングノートの「1.プロジェクトで使用するAPIを設定」をご覧ください。

 

 

1.APIキーの作成

 アプリケーションが下の条件を満たす場合、APIキーを使うことができます。

  • アプリケーションがウェブアプリケーションの場合
  • アプリケーションがユーザーデータを必要としない場合
  • アプリケーションが暦やブログなど公的なデータを使用する場合

 

 下の手順で、APIキーを作成します。

  1.  APIコンソール(https://console.developers.google.com/)にアクセスしAPI Magenerを開きます。
  2. Google APIsの右横に表示されているプロジェクト名を確認します。プロジェクトを変更したい場合やプロジェクトを作成したい場合は、プロジェクト名の右横の「▼」をクリックします。
  3. API Managerの左メニューに表示されている「認証情報」をクリックすると、「認証情報」画面が表示されます。
  4. 「認証情報を作成」をクリックします。
  5. APIキー」をクリックすると、API キーが作成され「API キーを作成しました 」と表示されます。
  6. 「自分の API キー」をコピーし大切に保管します。(右端のコピーアイコンをクリックするとコピーしやすいです。)

 作成したAPIキーは「認証画面」タブで確認することができます。

 

作成したAPIキーを使って、公開されているGoogleカレンダーから日本の祝日を取得する方法を紹介します。

詳しくは、Google APIをPHPウェブアプリケーションから呼び出す(APIキー) 第7回 - プログラミングノート をご覧ください。

 

2.APIキー使用の注意

  APIキーでプロジェクトを識別して、割り当てとアクセスが行われます。そのため、割り当ての盗用や不正使用を防止するため、APIキーの取り扱いには注意が必要です。

  • プログラムコードにAPIキーを直接記述せず、環境変数に設定したり、外部ファイルに記述します。
  • 外部ファイルにAPIキーを記述する場合、その外部ファイルはアプリケーションのソースツリーの外に保管します。
  • IPアドレス、HTTPリファラ―、モバイルアプリを指定して、APIキーの使用を制限します。
  • 不要なAPIキーは削除します。
  • 定期的にAPIキーを再作成し、APIキーを更新します。
  • プログラムコードを公開する場合、APIキーなど個人情報が含まれないように注意します。

 

 下の手順で、APIキー使用を制限します。

  1.  APIコンソール(https://console.developers.google.com/)にアクセスしAPI Magenerを開きます。
  2. Google APIsの右横に表示されているプロジェクト名を確認します。プロジェクトを変更したい場合やプロジェクトを作成したい場合は、プロジェクト名の右横の「▼」をクリックします。
  3. API Managerの左メニューに表示されている「認証情報」をクリックすると、「認証情報」画面が表示されます。
  4. 認証画面で表示されているAPIキーの名前をクリックすると、そのAPIキーの設定画面が表示されます。
  5. APIキーの設定画面で制限方法を選択します。「HTTPリファラ―(ウェブサイト)」、「IPアドレス(ウェブサーバー、cronジョブなど)」、「Androidアプリ」、「iOSアプリ」からいずれかを選びます。
  6. 制限方法を選択すると、それぞれの制限で必要な情報の入力欄が表示されます。入力後、「保存」を押します。

 

記事一覧

第1回 Google APIを使用するための設定(プロジェクトの作成・使用するAPIの設定)

第2回 Google APIを使用するための設定(認証情報の登録)

第3回 Google APIを使用するための設定(APIキーの作成)

第4回 Google APIをPHPウェブアプリケーションから呼び出す

第5回 Google APIをPHPウェブアプリケーションから呼び出す(サービスアカウント)

第6回 Google APIへの問い合わせ状況と割り当てを確認する方法

第7回 Google APIをPHPウェブアプリケーションから呼び出す(APIキー)

 

参照

「Manage APIs in the API Console - API Console Help」

https://support.google.com/googleapi/answer/7037264?hl=en&ref_topic=7013279

「Setting up API keys」と「Best practices for securely using API keys」を参照しました。