English

MIRAIT ONE GROUP

地図コンテンツAPI配信サービス ブログ

PAREA-APIの仕様変更に関する事前案内

2023/08/16

お知らせ

いつも地図コンテンツAPI配信サービス「PAREA-API」をご利用いただきありがとうございます。
本書はPAREA-APIの次回バージョンアップにおいてデータの仕様変更がある場合に、利用者様が円滑にご準備いただけるよう、仕様変更内容について事前案内するものです。

はじめに

本書の内容につきましては、本書配信時点での予定となっておりますため、実際の仕様変更内容が未確定の場合や本書と異なる場合がございます。正式な仕様につきましては、バージョンアップリリース予定日より2週間前に配信するリリース告知書にてご案内いたしますので、ご了承いただけますようお願い申し上げます。
2023年v3(2023年9月リリース)では、下記の仕様変更を予定しています。
なお従前の仕様は、仕様変更実施から約3カ月間は引き続きご利用頂けます。

■バージョンアップリリース予定日

2023年9月13日(水)13時~

■リリース後、参照可能なバージョン

バージョン3(v3)は今回新規に配信されます。
バージョン2(v2)の配信はそのまま有効です。
バージョン1(v1)は配信されなくなります。

■仕様変更内容

1 REST API「気候情報」において属性項目を追加
仕様変更内容:気候情報のREST API(/contens/jma/rain)のリクエストに対して返却される項目に「猛暑日」が追加される
影響のあるユーザ:気候情報コンテンツのREST APIを利用しているユーザ

2 【重要】認証APIのサンプルコードにPHP/OpenSSLを追加
仕様変更内容:認証APIのサンプルコードにPHP/OpenSSLを新規追加する。
影響のあるユーザ:PHP7.1以上(PHP7.2で削除)を利用しているユーザ

今後のバージョンにおける仕様変更予定

【重要】「浸水の可能性(浸水想定区域)」における新規APIの追加
仕様変更内容:令和以降に作成された「浸水の可能性(浸水想定区域)」のREST API、地図APIを新規追加する。
リリース時期:2023年v4(2023年11月頃)
影響のあるユーザ:「浸水の可能性(浸水想定区域)」のREST API、地図APIを利用しているユーザ

お問い合わせ

本書の内容に関するお問合せは、次のメールアドレスまでお寄せください。

PAREA-APIお問い合わせ先: pareaapi_support@kk-grp.jp

<ご参考>

1. リリースサイクルとバージョン指定の考え方について

○ リリースサイクル
■ PAREA-APIは、四半期に1度(概ね2月・5月・8月・11月頃)新バージョンをリリースします。
■ バージョン1(v1)~バージョン4(v4)までをローテーションし、v4の次はv1に戻ります。
■ 各バージョンはリリース後、2世代先のバージョンがリリースされるまでの約6カ月間使い続ける事ができます。
■ 各コンテンツの追加、更新、仕様変更、廃止等は、バージョン毎に行われます。

○ バージョン指定
 ■ 現在存在するバージョンのうち、参照するバージョンを指定する事ができます。
 ■ バージョンを指定することで、各コンテンツの更新、仕様変更等に対して、アプリケーション側で仕様変更等を反映するタイミングをコントロールいただけます。
 ■ バージョンを指定しない場合は、常に最新バージョンを参照します。
 ■ バージョン指定なし:
  ●常にその時の最新バージョンを参照します。
  ●新規コンテンツや更新されたデータをいち早くアプリケーション側に取り入れる事ができます。
  ●コンテンツの仕様変更に対して即座にアプリケーション側の設定変更を行う必要があります。
  ●データ更新における未検知のエラーが生じる場合があります。
 ■ バージョン0指定:
  ●常にその時の1世代前のバージョンを参照します。
  ●コンテンツの仕様変更に対して、アプリケーション側の設定変更までに一定期間の準備期間を持つことができます。
  ●リリース後約3カ月間運用された比較的安定的な環境です。

2. 用語の定義

○PAREA-APIで用いる用語を以下の通り定義します。
 ■ コンテンツ
  ●PAREA-APIから提供されるテーマ毎に分けた情報群を指す。
 ■ データ
  ●コンテンツに含まれる画像や文字や数値等の情報を指す。
 ■ アプリケーション
  ●PAREA-APIご利用者がお持ちの、PAREA-APIを組み込むシステム、サービス、アプリケーション等を指す。

次世代地図コンテンツAPIシリーズ PAREA-API Static & Dynamic