目次
概要
APIの新たなバージョンとなるv3 APIの正式版の提供を開始しました。
v3では、現行のv2 APIで情報項目ごとに分かれているエンドポイントを整理し、ArcGISのサービスタイプを単位としたエンドポイント構成へ変更しました。
その他の主要な変更点は「v2 APIからの主な変更点」をご確認ください。
現在お使いの海しるAPIサブスクリプションキーは、v3でも変わらずお使い頂けます。
その他、利用規約等についても変更はありません。
v2 APIからの主な変更点
-
エンドポイントの構成を変更しました。
v2では情報項目ごとにエンドポイントを設けていましたが、 v3ではArcGISのサービスタイプを単位とした構成に変更しました。
v3のエンドポイント構成の概要は「v3 APIの提供構成」を、 v2の各情報項目のエンドポイントが、v3のどのエンドポイントに対応するかは、「最新の移行対応表」をご確認ください。
-
GISソフトウェアでURLを設定するだけでデータを利用できます。
v3では、プラグイン等の追加インストールを行うことなく、ArcGIS OnlineやQGIS等でURLを設定するだけでv3で提供している情報をすぐに解析可能なデータとして利用できます。
詳しいご利用方法は、「利用者向け説明書」をご確認ください。
-
一部の操作が変更・廃止されます。
v2で利用可能な一部の操作が、v3では変更・廃止されます。
一例として、v3の移行先がArcGIS FeatureServiceの情報の場合、FeatureServiceはベクトルデータを返すAPIのため、v2で利用可能な操作「画像出力」は廃止されます。
v2と、移行先のv3における利用可能な操作の対応は「最新の移行対応表」をご確認ください。
-
一部のパラメータ、レスポンスを変更しました。
設定可能なパラメータとレスポンスの例は、「海しるAPI v3仕様書」でご確認いただけます。
また、パラメータについては、海しるAPIウェブサイトの下記APIページでもご確認いただけます。下記ページではTry it機能もご利用いただけます。
・API ArcGIS FeatureServiceのウェブページ
・API ArcGIS ImageServiceのウェブページ(準備中)
変更対象
「潮汐推算」・「潮流推算」・「データカタログ」は既にv3 APIとして提供済みです。 今回のv3 APIでは、それ以外の情報項目を対象として新しいエンドポイント構成を提供します。
v3 APIのエンドポイント構成概要
v3 APIは、以下のエンドポイント構成で提供します。
| エンドポイント | 対応する情報 | 提供状況 |
|---|---|---|
| ArcGIS FeatureService | 島名など、大多数のv2の情報項目が対応 | 正式版 提供済み |
| ArcGIS ImageService | 検討中 | 検討中 |
| 潮汐推算・潮流推算 | 潮汐推算、潮流推算 | 正式版 提供済み |
| データカタログ | データカタログ | 正式版 提供済み |
※ 「潮汐推算」・「潮流推算」・「データカタログ」はすでにv3で提供しているため、 今回の変更対象外です。
ベータ版公開時にはArcGIS MapServiceの提供を検討していましたが、 検討の結果、海しるAPI v3では提供しないこととしました。
ベクトルデータについては、 ArcGIS FeatureServiceによる提供に統一します。
v2 → v3 移行情報
v2 APIをご利用中の方は、v3 APIへの移行にあたり、現在ご利用のエンドポイントが v3ではどのエンドポイントに対応するかをご確認ください。
v3正式版の提供開始
令和8年(2026年)10月30日より、 海しるAPI v3正式版の提供を開始しました。
海しるAPI v3は、ベータ版での提供および検証を経て、 正式版として提供を開始しました。
ベータ版をご利用いただいた皆様、 および貴重なご意見・ご要望をお寄せいただいた皆様に厚く御礼申し上げます。
今後も情報項目ごとに準備が整ったものから、 順次提供範囲を拡大していく予定です。
v2 APIの提供終了予定
現行のv2 APIは、v3 APIの正式提供から1年後を目途(2027年12月末)に提供終了予定です。
v2をご利用の皆様におかれましては、お手数をおかけしますが、v3への移行をご検討くださいますようお願いいたします。