各種クラウド連携サービス（WebAPI）の登録方法

これから紹介するプログラムで利用するクラウド連携サービス（WebAPI）は基本的に無料であるが、事前にアカウント登録が必要なものがある。ここでは、それらの登録方手順についてまとめて説明する。

1. .pahooEnv ファイルについて
2. Google Cloud Platform
3. Gemini
4. Yahoo!JAPAN デベロッパーネットワーク
5. 楽天ウェブサービス
6. Twitter(現・X) API
7. Bluesky API
8. API Ninjas
9. bit.ly
10. IP2Location.io
11. RapidAPI
12. API FLASH
13. e-Stat 政府統計の総合窓口
14. 参考サイト

後述する各種クラウドサービスに登録したときに取得するアカウント情報、アプリケーションパスワードなどを .pahooEnv ファイルに記入し一元管理することで、当サイトで紹介するプログラムから参照できるようになる。
なお、これまで通り、「PHPクラスの紹介」で紹介している各クラスファイルのプロパティに直接記述することでも参照可能だが、セキュリティ強化を目的として、.pahooEnv ファイルに分離するようにした。

.pahooEnv ファイルのフォーマットは以下の通り。後述するとおり、環境変数 $_ENV に代入するので、変数名は既存環境変数と被らないものにする。

# (コメント)
(変数名1) = (値1)
(変数名2) = (値2)
(変数名3) = (値3)

.pahooEnv ファイルは、include_path が通ったディレクトリで、秘匿性を守るために外部から参照されないディレクトリ配置してほしい。

.pahooEnv ファイル、は "pahooInputData.php" にある pahooLoadEnv 関数によって、環境変数 $_ENV に読み込まれる。

pahooInputData.php

  23: /**
  24:  * .env ファイルからデータを読み込む
  25:  * .env ファイルは include_path が通っているディレクトリに配置すること
  26:  * @param   string $fname 読み込む.envファイル名（省略時：.pahooEnv）
  27:  * @return  bool TRUE：.envファイルから読み込んだ／FALSE：読み込まなかった
  28: */
  29: function pahooLoadEnv($fname = '.pahooEnv') {
  30:     // include_path に .env がある想定
  31:     $paths = explode(PATH_SEPARATOR, get_include_path());
  32:     $envFile = NULL;
  33: 
  34:     // include_path のどこかにある .env を探す
  35:     foreach ($paths as $path) {
  36:         $candidate = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $fname;
  37:         if (file_exists($candidate)) {
  38:             $envFile = $candidate;
  39:             break;
  40:         }
  41:     }
  42: 
  43:     // 環境変数 $_ENV[] にデータを読み込む
  44:     if ($envFile) {
  45:         foreach (file($envFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) as $line) {
  46:             // コメント行スキップ
  47:             if (str_starts_with(trim($line), '#')) {
  48:                 continue;
  49:             }
  50:             // KEY=VALUE の形式をパース
  51:             [$name, $value] = array_map('trim', explode('=', $line, 2));
  52:             // すでに $_ENV[$name] があったらスキップ
  53:             if (! isset($_ENV[$name])) {
  54:                 $_ENV[$name] = $value;
  55:             }
  56:         }
  57:     } else {
  58:         return FALSE;
  59:     }
  60: 
  61:     return TRUE;
  62: }

読み込むファイル名は引数で指定できるが、デフォルト引数を .pahooEnv にした。
まず、 get_include_path  関数を使い、include_path に定義されているディレクトリを配列 $paths に格納する。
次に for文を回し、目的のファイルのフルパス $candidate があるかどうか、 file_exists  関数を使って探す。ヒットしたらループから脱出する。

見つかったファイルをオープンしたら、for文を回し、コメント行をスキップしつつ、KEY=VALUE の形式をパースし、環境変数 $_ENV に格納していく。
すでに $_ENV[$name] があったらスキップするようにしたので、取り込んだ環境変数が上書きされることはない。逆に言うと、OSの環境変数に .pahooEnv を書いておくことで、.pahooEnv ファイルを用意しなくても同じ結果が得られる。

現在、Geminiは無料で利用できるが、いくつかの制限がある。テキスト生成、翻訳、要約などを行うには無料モードで十分だが、画像生成や音声認識を行うには有料モードを検討した方がいいだろう。

2020年（令和2年）10月31日をもって、Yahoo! JavaScriptマップAPIなど地図表示のAPIサービスが終了することが公表された。→【重要】YOLP Web APIにおける一部API・SDKの提供終了お知らせ

ゼンリンデータコムやMapboxへの移行を案内しているが、いずれも有料サービスのようだ。

Twitter APIは、Twitter(現・X)にツイートしたりトレンドを検索するなどのサービスを提供するAPIである。
Twitter(現・X)社がイーロン・マスク氏に買収され、API有料化などの情報が流れたが、2023年（令和5年）6月現在、24時間に50ツイートまで、アプリケーションは1つまでなどの条件付きで、freeプラン（無料）が利用できる。Twitter API v2 のみ利用できるが、v2へ移行していない機能については Twitter API v1.1 を併用していく形になっている。
APIを利用するまでの手続きはすべて英語である。

まず、Twitter(現・X) にログインし、Developer Platform にアクセスし、画面下方にある Freeプランの Get started をクリックする。

チェックボックスの意味は次の通り。すべてチェックして同意すること。
You understand that you may not resell anything you receive via the Twitter APIs‥‥ユーザーは、Twitter APIを通じて受け取ったものを再販することができないことを理解するものとする。
You understand your Developer account may be terminated if you violate the Developer Agreement or any of the Incorporated Developer Terms‥‥ユーザーは、ユーザーがデベロッパー規約またはデベロッパー規約のいずれかに違反した場合、ユーザーのデベロッパーアカウントが停止される場合があることを理解するものとする。
You accept the Terms & Conditions‥‥本規約に同意する。

プロジェクトの名前、用途（選択式）、説明を順々に記入していく。いずれも英語で記入すること。また、記入内容は後で変更することができる。

Bluesky APIは、Bluesky に投稿したり記事を検索するなどのサービスを提供するAPIで、無料で利用ができる。APIを利用するまでの手続きはすべて英語である。

IP2Location.io は、IPアドレスから住所を求めることができるWebサービスだ。サイトへの訪問者の地理的位置を特定するために利用されている。
商業エディションと無償のLITEエディションがあり、後者はIPアドレスの上3桁目までを判定の対象にするため、都市レベルでの正確さは約60％となっている。
商用エディションでは都市レベルでの正確さが約80％に向上するが、毎月49ドルからのサブスクリプションとなっている。
ここでは、無償のLITEエディションを利用し、API呼び出しに必要なアクセストークンを取得する方法を紹介する、

RapidAPI は、世界最大級のAPIマーケットプレイスとして、さまざまなクラウド連携サービスを提供している。また、それぞれのAPIの仕様、テストページ、各種言語での実装例も充実している。
利用するには、RapidAPIで共通に利用できる APIキーを入手する。
また、利用料はAPIによって異なるので、利用APIのマニュアルを確認してほしい。

RapidAPI にアクセスしたら、右上の Sign Up をクリックする。

アプリケーションの管理画面に切り替わる。
Add New App をクリックし、必要なアプリケーション情報を入力し、Add app をクリックする。

登録したアプリは、左ペインの My Apps に追加される。そのアプリをクリックし、Authorization をクリックすると、右側に Application Key を表示する。これから紹介するPHPプログラムで必要となる。.pahooEnv の PAHOO_RAPIDAPIKEY に設定する。

API FLASH は、指定したURLをブラウザで表示したときの画面イメージをデータとして取得できるクラウドサービスだ。直近1ヶ月の作成画像データが100枚以内であれば無料で利用できる。

API FLASH の右上の「Sign up」をクリックし、メールアドレスまたは連携SNS認証でユーザー登録する。
ログインしたら、ダッシュボードが表示される。右上に「Access keys」をクリックし、「New access key」をクリックして、新規にアクセス・キーを作成する。これから紹介するPHPプログラムで必要となる。.pahooEnv の PAHOO_APIFLASH_ACCESSKEY に設定する。

e-Stat 政府統計の総合窓口 は、日本の統計が閲覧できる政府統計ポータルサイトだ。APIを提供しており、さまざまな統計データを利用することができる。

APIを利用するには、「ユーザ登録」ページにメールアドレスを入力して仮登録する。まもなくメールが送られてくるので、本登録を行う。
ログインしたら、ダッシュボードの上にある「API機能(アプリケーションID発行)」をクリックし、必要な情報を入力し、「発行」をクリックする。すると、appID が表示される。これから紹介するPHPプログラムで必要となる。.pahooEnv の PAHOO_ESTAR_APIKEY に設定する。

• Google Cloud Platform
• Gemini
• Yahoo!JAPAN デベロッパーネットワーク
• 楽天ウェブサービス
• Twitter Deveroper
• gooラボ
• bit.ly
• IP2Location.io
• RapidAPI
• API FLASH
• e-Stat 政府統計の総合窓口