PHPackages                             imo-tikuwa/resas-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. imo-tikuwa/resas-api-client

ActiveLibrary[API Development](/categories/api)

imo-tikuwa/resas-api-client
===========================

v0.2.4(5y ago)011MITPHPPHP >=5.4.0

Since Jun 3Pushed 5y ago1 watchersCompare

[ Source](https://github.com/imo-tikuwa/resas-api-client)[ Packagist](https://packagist.org/packages/imo-tikuwa/resas-api-client)[ RSS](/packages/imo-tikuwa-resas-api-client/feed)WikiDiscussions master Synced today

READMEChangelog (6)Dependencies (2)Versions (8)Used By (0)

resas-api-clientについて
====================

[](#resas-api-clientについて)

地域経済分析システム（RESAS：リーサス）のデータを取得するAPIをラップしたクライアントプログラムです。
php5.4以上であれば大体動くと思います。
※使用するにはRESASのAPIキーが必要です。

インストール
------

[](#インストール)

```
composer require imo-tikuwa/resas-api-client

```

使い方
---

[](#使い方)

1. ResasApiClientのコンストラクタでAPIキーを渡してあげてください。
2. find関数で使用するAPIのアクションと必要に応じてパラメータをセット。
3. 以下のいずれかでデータを取得

関数名内容toArray()結果を配列として返しますtoJson()結果をjson文字列として返しますtoObj()結果をオブジェクトとして返しますtoExport($filename)結果を$filenameで指定したパスにインクルード可能なphpファイルとして出力します。.envについて
--------

[](#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