imo-tikuwa / resas-api-client
v0.2.4
2020-06-08 23:41 UTC
Requires
- php: >=5.4.0
- vlucas/phpdotenv: 4.1
Requires (Dev)
- monolog/monolog: ^1.25
This package is auto-updated.
Last update: 2024-09-09 09:09:20 UTC
README
地域経済分析システム(RESAS:リーサス)のデータを取得するAPIをラップしたクライアントプログラムです。
php5.4以上であれば大体動くと思います。
※使用するにはRESASのAPIキーが必要です。
インストール
composer require imo-tikuwa/resas-api-client
使い方
- ResasApiClientのコンストラクタでAPIキーを渡してあげてください。
- find関数で使用するAPIのアクションと必要に応じてパラメータをセット。
- 以下のいずれかでデータを取得
.envについて
以下の環境変数を作成しておくことでResasApiClientのコンストラクタ呼び出しの際にAPIキーを渡すことを省略できます。
ENV_RESAS_API_KEY="[API キー]"
サンプルコード
以下は東京都の市区町村を取得するプログラムになります。
require_once (dirname(__DIR__) . "/vendor/autoload.php");
use TikuwaApp\Api\ResasApiClient;
$api_key = '[API キー]';
$resas_api_client = new ResasApiClient($api_key);
$result = $resas_api_client->find('api/v1/cities', ['prefCode' => '13'])->toArray();
以下は東京都の市区町村のうち「〇〇区」に一致する自治体のみを絞り込んでKey,Valueの配列で取得するプログラムになります。
require_once (dirname(__DIR__) . "/vendor/autoload.php");
use TikuwaApp\Api\ResasApiClient;
$resas_api_client = new ResasApiClient();
$result = $resas_api_client->find('api/v1/cities', ['prefCode' => '13'])
->setKeyValuePath("{n}[cityName=/^.+区$/].cityCode", "{n}[cityName=/^.+区$/].cityName")
->toArray();
以下は都道府県のコード値が15以下のものについてKey,Valueの配列で取得し、ファイルに出力するプログラムになります。
require_once (dirname(__DIR__) . "/vendor/autoload.php");
use TikuwaApp\Api\ResasApiClient;
$date = new DateTime();
$date->setTimezone(new DateTimeZone('Asia/Tokyo'));
$filename = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'logs' . DIRECTORY_SEPARATOR . basename(__FILE__, ".php") . '_' . $date->format('YmdHis') . '.php';
(new ResasApiClient())->find('api/v1/prefectures')
->setKeyValuePath("{n}[prefCode<=15].prefCode", "{n}[prefCode<=15].prefName")
->toExport($filename);
リンク
RESAS-API - 地域経済分析システム(RESAS)のAPI提供情報
RESAS-API - API概要
ライセンス
ソースの一部にcakephp/utilityのプログラムを使用させていただいています。