Web API を利用する

最終更新日: 2022年8月15日

住所確認APIを試す

ここではジオテクノロジーズ社が提供している「住所確認API」を使って、HTTP通信を行う例を説明します。

住所確認APIを使うために無料トライアルアカウントを作成し、APIキーを入手します。

APIキーを入手する

APIキーが必要です

APIキーが未入力または誤っている場合、住所確認APIの動作を確認することはできません。

デモアプリケーション

アドオンギャラリー「住所正規化デモ」をインストールしてください。

アドオンギャラリー住所正規化デモ

ビルドすると「会社」というモデルが用意されます。新規登録画面を開きます。

デモ用の会社モデル

入手したAPIキーと、任意の住所文字列を入力します。

APIキーと住所文字列を入力する

入力するとAPIを呼び出し、住所の正規化結果が表示されます。

住所の正規化処理を確認できる

WebAPIの呼び出し

この例では「隠し正規化結果JSON」という項目に、WebAPIの呼び出し結果の文字列を格納するスクリプトを用意しています。

WebAPIを呼び出すには、外部連携ブロック群にあるAPI呼び出しブロックを使います。

WebAPI呼び出しブロック

ジオテクノロジーズ社の住所確認API v1 の仕様は次のようになっています。

https://api-anorm.mapfan.com/v1/住所文字列.json

ここで "住所文字列" は URL エンコードされた文字列である必要があるため、文字列関数 URLENCODE を使います。

さらに、この API は認証キーが必要です。(多くの WebAPI は、このようにキーが必要です。)

「リクエストヘッダ」部に、それぞれの WebAPI の仕様にあわせた文字列をセットします。今回の場合は次のようになっています。

"x-api-key" : "(YOUR API KEY)"

住所確認APIの呼び出し

その他のWebAPIを利用する場合

そのWebAPIが提供している「問い合わせのためのURLの書式」にあわせて文字列を組み立てください。多くの場合、認証のためのキーをリクエストヘッダに指定します。

JSONの解析

WebAPIの戻り値は、JSON形式の文字列になっています。この文字列から任意の値を取得するためにJSON文字列解析ブロックを使います。

JSON文字列を解析するブロック

戻り値のJSON文字列が、どういう構造になっているか、はそれぞれのWebAPIが規定しています。"JSON Path" という書式によって、任意の値を取得できます。

JSON文字列の解析例

今回利用した、住所確認APIのJSON文字列は、次の書式で取得できます。

正規化された文字列 features[0].properties.place_name
都道府県 features[0].properties.pref
都道府県カナ features[0].properties.pref_kana
市区町村 features[0].properties.city
市区町村カナ features[0].properties.city_kana
町域 features[0].properties.area
町域カナ features[0].properties.area_kana
小字丁目 features[0].properties.koaza_chome
小字丁目カナ features[0].properties.koaza_chome_kana
番地号 features[0].properties.banchi_go
ビル名 features[0].properties.building
階数 features[0].properties.building_number
郵便番号 features[0].properties.zipcode
マッチレベル features[0].properties.geocoding_level
マッチレベル説明 features[0].properties.geocoding_level_desc
ログ features[0].properties.log
正規化できなかった文字列 features[0].properties.not_normalized

その他のWebAPIを利用する場合

そのWebAPIが提供している「戻り値のJSON文字列の構造」にあわせて、JSON Path を指定してください。