Go to Qiita Advent Calendar 2024 Top
LoginSignup
0
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

@rimorimo(Yuki Moriya)

APIを使い郵便番号から住所が検索できるWebサービスをPHPで作成する方法

Last updated at Posted at 2021-03-31

概要

本記事では郵便番号データ配信サービスzipcloud様が提供するAPIを用いて，7桁の郵便番号を入力すると住所が検索できるWebサービスの作製法を記載する．

事前リサーチ: ブラウザで様々なパターンのJSONを表示検証してみる

下記URLの後ろに様々な文字列を連結してブラウザでアクセスしてみる．
https://zip-cloud.appspot.com/api/search?zipcode=

{
	"message": null,
	"results": [
		{
			"address1": "東京都",
			"address2": "港区",
			"address3": "芝公園",
			"kana1": "ﾄｳｷｮｳﾄ",
			"kana2": "ﾐﾅﾄｸ",
			"kana3": "ｼﾊﾞｺｳｴﾝ",
			"prefcode": "13",
			"zipcode": "1050011"
		}
	],
	"status": 200
}

{
	"message": null,
	"results": null,
	"status": 200
}

{
	"message": "パラメータ「郵便番号」の桁数が不正です。",
	"results": null,
	"status": 400
}

{
	"message": "パラメータ「郵便番号」に数字以外の文字が指定されています。",
	"results": null,
	"status": 400
}

{
	"message": "必須パラメータが指定されていません。",
	"results": null,
	"status": 400
}

JSONの検証により，コードを記述の際はステータスコード（200, 400の2種）とエラーメッセージ(A, B, Cの3種)により条件分岐を行う必要がある事が判明した．

Webサービスの作製

【システム環境】
OS X El Capitan 10.11以降（他のOSでも可）
Apache 2.4.28以降
PHP 5.5.38以降

本記事ではディレクトリ操作をMacに合せて記述しているため，他のOS（Linux, Windows等）の使用時は必要に応じてディレクトリ構造を置き換えて考えるものとする．

  • ディレクトリとファイルの作成
$ sudo mkdir /Library/WebServer/Documents/AddressSearch
$ sudo touch /Library/WebServer/Documents/AddressSearch/address_search.php
$ sudo mkdir /Library/WebServer/Documents/AddressSearch/common
$ sudo touch /Library/WebServer/Documents/AddressSearch/common/getCity.php
$ sudo mkdir /Library/WebServer/Documents/AddressSearch/js
$ sudo touch /Library/WebServer/Documents/AddressSearch/js/copyToClipboard.js
$ sudo mkdir /Library/WebServer/Documents/AddressSearch/css
$ sudo touch /Library/WebServer/Documents/AddressSearch/css/address_search.css
  • 検索用フォームaddress_search.phpのソースコード
address_search.php
<?php
require_once __DIR__ . '/common/getCity.php';

$title = '住所検索';

$zipcode = isset($_POST['zipcode']) ? $_POST['zipcode'] : null;

/**
 * 郵便番号にスペース（半角または全角）が含まれる場合，
 * スペースを削除して検索結果に反映する
 */
$zipcode = preg_replace('/( |　)/', '', $zipcode);
$address = getCity($zipcode);
?>
<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="css/address_search.css">
    <title><?= $title; ?></title>
  </head>
  <body>
    <h1><?= $title; ?></h1>
    <form action="" method="post">
      <input type="text" name="zipcode" maxlength=7 style="width:55px;" value="<?= $zipcode; ?>">
      <input type="submit" value="検索"><br>
      <input id="copyTarget1" type="text" name="place" style="width:480px;"value="<?= $address; ?>">
      <button onclick="copyToClipboard(1)">Copy</button>
    </form>
    <script src="js/copyToClipboard.js"></script>
  </body>
</html>
  • メインモジュールgetCity.phpのソースコード
getCity.php
<?php
# 郵便番号検索APIを利用した住所を取得する関数
function getCity($zipcode) {

    /**
     * 郵便番号にスペース（半角または全角）が含まれる場合，
     * Warning: file_get_contents対策のためスペースを削除して検索結果に反映する
     */
    $zipcode = preg_replace('/( |　)/', '', $zipcode);

    # URLの連結
    $api_url = 'https://zip-cloud.appspot.com/api/search?zipcode=' . $zipcode;

    # URLの読み込み
    $api_url = file_get_contents($api_url);

    # JSON文字列をデコード（第二引数をtrueにすることでJSON文字列を連想配列にする）
    $json = json_decode($api_url, true);

    # ステータスコード
    $status = $json['status'];

    # エラーメッセージ
    $message = $json['message'];

    # 住所詳細の配列
    $results = $json['results'];

    # 取得値の分岐
    if ($status == 400):
        if ($message == '必須パラメータが指定されていません。'):
            $output = '上のテキストボックスに7桁の「郵便番号」をハイフンなしで入力してください．';
            return $output;
        elseif ($message == 'パラメータ「郵便番号」の桁数が不正です。'):
            $output = '「郵便番号」の桁数が不正です．';
            return $output;
        elseif ($message == 'パラメータ「郵便番号」に数字以外の文字が指定されています。'):
            $output = '「郵便番号」に数字以外の文字が指定されています．';
            return $output;
        endif;
    elseif ($status == 200):
        if ($results == null):
            $output = '入力された「郵便番号」に該当する住所が見つかりませんでした．';
            return $output;
        elseif ($results != null):

            # 住所詳細
            for ($i = 0; $i <=2; $i++):
                $address[$i] = array_values($results[0])[$i];
            endfor;

            $output = $address[0] . $address[1] . $address[2];
            return $output;
        endif;
    endif;
}
  • 検索結果のコピー機能copyToClipboard.jsのJavaScriptソースコード
copyToClipboard.js
function copyToClipboard(index) {
    var copyTarget = document.getElementById('copyTarget' + index);
    copyTarget.select();
    document.execCommand('Copy');
    alert('Copied: ' + copyTarget.value);
}
  • Webページ表示設定ファイルaddress_search.cssのCSSソースコード
address_search.css
body {
  background-color: #000000;
  color: #00ff00;
}

動作確認

Apacheの起動

$ sudo apachectl start

ブラウザ上に**localhost/AddressSearch/address_search.php**を入力して動作確認を行う．

初期状態
postal1.png

実在する郵便番号1050011を入力
postal2.png

実在しない郵便番号1234567を入力
postal3.png

7桁未満の番号105を入力
postal4.png

文字列を105hogeを入力
postal5.png

今回はAPIを用いた情報取得の類としては簡単な部類の「住所検索」について記述した．次は応用編としてAPIを用いたOpenWeatherMapから気象情報を取得する方法に関して記述予定である．

0
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?