変 更 履 歴 Version 日 付 変 更 内 容 /8/23 初 版 作 成 /1/17 問 い 合 わせ 先 情 報 の 市 区 町 村 名 都 道 府 県 名 利 用 上 の 制 約 お よびデータアクセス URL の4つの 検 索 API パラメータの 追

Transcription

1 災 害 リスク 情 報 クリアリングハウス API 仕 様 書 Version /01/15 独 立 行 政 法 人 防 災 科 学 技 術 研 究 所

2 変 更 履 歴 Version 日 付 変 更 内 容 /8/23 初 版 作 成 /1/17 問 い 合 わせ 先 情 報 の 市 区 町 村 名 都 道 府 県 名 利 用 上 の 制 約 お よびデータアクセス URL の4つの 検 索 API パラメータの 追 加 /6/13 検 索 API(REST)に INCLUDEPLANNDED パラメータ 追 加 登 録 API に OPENMODE パラメータ 追 加 認 証 API の 追 加 /1/15 XYZ タイルおよび TMS に 関 するメタデータ 仕 様 の 変 更 およびアクセス 制 限 管 理 機 能 の 追 加 による 改 訂 2

3 目 次 1. はじめに API 一 覧 メタデータ 登 録 API メタデータのファイルを 送 る 場 合 クリアリングハウスがメタデータを 参 照 して 登 録 させることを 行 う 場 合 メタデータ 更 新 API メタデータ 削 除 API クリアリングハウス 検 索 API 条 件 検 索 (CSW 準 拠 ) 条 件 検 索 ( 独 自 REST 形 式 ) 個 別 メタデータ 取 得 (CSW 準 拠 ) 個 別 メタデータ 取 得 ( 独 自 REST 形 式 ) クリアリングハウス 認 証 API ログイン ログアウト

4 1. はじめに 本 書 は 防 災 科 学 技 術 研 究 所 が 開 発 した 災 害 リスク 情 報 および 災 害 情 報 の 共 有 のためのクリアリングハウスを 外 部 か ら 利 用 するための API について 記 述 したものです 本 書 に 記 載 の API で 扱 うメタデータの 詳 細 については 別 紙 災 害 リスク 情 報 クリアリングハウス メタデータ 説 明 書 を 参 照 してください 4

5 2. API 一 覧 API の 仕 様 については 下 記 の 3 項 目 7 種 類 の API である なお メタデータ 登 録 更 新 削 除 API については OGC が 定 めた CSW に 仕 様 はないため 今 回 新 たに API を 策 定 した クリアリングハウス 検 索 API については CSW に 準 拠 するものと 利 便 性 を 考 慮 した REST 形 式 の 独 自 API を 用 意 する メタデータ 登 録 更 新 削 除 API メタデータ 登 録 API メタデータ 更 新 API メタデータ 削 除 API メタデータ 検 索 API 条 件 検 索 API 個 別 メタデータ 取 得 API 認 証 API ログイン API ログアウト API 情 報 を 共 有 する 主 体 がメタデータをクリアリングハウスへ 登 録 する 際 に 使 用 す る API メタデータのファイルを 送 る 場 合 と 外 部 のメタデータを URL で 取 得 さ せる 場 合 の 2 種 類 がある 情 報 を 共 有 する 主 体 が 既 にクリアリングハウスへ 登 録 してあるメタデータを 更 新 する 際 に 使 う API 情 報 を 共 有 する 主 体 が 既 にクリアリングハウスへ 登 録 してあるメタデータを 削 除 する 際 に 使 う API 情 報 を 利 活 用 する 主 体 が クリアリングハウスに 対 して 条 件 に 基 づきメタデー タから 地 図 データを 検 索 する 際 に 使 う API CSW に 準 拠 するものと REST 形 式 の 独 自 の API を 用 意 する 情 報 を 利 活 用 する 主 体 が 個 別 の 地 図 データのメタデータを 取 得 する 際 に 使 う API CSW に 準 拠 するものと REST 形 式 の 独 自 の API を 用 意 する 情 報 を 利 活 用 する 主 体 が クリアリングハウスに 対 してログインするための API ログインすることで メタデータの 登 録 更 新 削 除 が 可 能 になる また ログイ ンユーザにのみ 公 開 されたメタデータへのアクセスが 可 能 になる クリアリングハウスからログアウトするための API 上 記 API のうち メタデータの 登 録 更 新 削 除 API およびメタデータ 検 索 API を 提 供 する URL は 以 下 の 通 り 名 /CatalogueService/servlet/NIEDCatalogueService 認 証 API を 提 供 する URL は 以 下 の 通 り 名 /CatalogueService/servlet/AccountPermissionService サーバ 名 はクリアリングハウスがインストールされたサーバのホスト 名 または IP アドレス 5

6 3. メタデータ 登 録 API クリアリングハウスにメタデータを 登 録 するには 予 めクリアリングハウスにメタデータ 登 録 権 限 を 持 つユーザでログインして いる 必 要 がある ログインについては 7.クリアリングハウス 認 証 API を 参 照 3.1. メタデータのファイルを 送 る 場 合 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) METHOD: POST(multipart/form-data) パラメータ 値 説 明 SERVICE * CSW 固 定 VERSION * 固 定 REQUEST * UploadMetadata 固 定 REDIRECTURL * リダイレクト 先 URL 登 録 後 に REDIRECT するページの URL を 指 定 する この URL には パラメータ FILEIDENTIFIER が 渡 される パラメータの 値 は 以 下 の 通 り 登 録 成 功 - 登 録 したメタデータのファイル 識 別 子 登 録 失 敗 - 空 REDIRECT 不 要 の 場 合 は 以 下 を 指 定 する /CatalogueService/csw/edit/dummy.jsp METADATAFILE * メタデータファイル(XML) 登 録 するメタデータファイル OVERVIEWFILE サムネイル 画 像 ファイル サムネイルとして 表 示 する 画 像 ファイル(gif,png,jpeg) サムネイル 画 像 の URL がメタデータ 内 に 記 述 されている 場 合 は 省 略 可 サムネイル 画 像 が 不 要 の 場 合 は 省 略 可 DISASTERTYPE 災 害 区 分 以 下 のいずれか 1: 地 震 2: 津 波 高 潮 3: 火 山 4: 風 水 5: 土 砂 6: 氷 雪 7:その 他 地 図 データが 対 象 とする 災 害 の 区 分 を 指 定 する 対 象 の 災 害 区 分 を 特 定 しない 場 合 は 指 定 しなくてもよ い 6

7 OPENMODE 公 開 設 定 以 下 のいずれか 0: 常 に 公 開 1:ログインユーザに 公 開 -1: 非 公 開 メタデータの 公 開 範 囲 を 設 定 する 常 に 公 開 はクリアリングハウスへのログインの 有 無 にか かわらず 全 て 利 用 者 がアクセス 可 能 なメタデータ ログインユーザに 公 開 はクリアリングハウスにログイン 中 の 利 用 者 のみアクセス 可 能 なメタデータ 非 公 開 はメタデータの 登 録 者 または 管 理 者 でログイン 中 のみアクセス 可 能 なメタデータ 7

8 3.2. クリアリングハウスがメタデータを 参 照 して 登 録 させることを 行 う 場 合 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 SERVICE * CSW 固 定 VERSION * 固 定 REQUEST * UploadMetadata 固 定 REDIRECTURL * リダイレクト 先 URL 登 録 後 に REDIRECT するページの URL を 指 定 する この URL には パラメータ FILEIDENTIFIER が 渡 される パラメータの 値 は 以 下 の 通 り 登 録 成 功 - 登 録 したメタデータのファイル 識 別 子 登 録 失 敗 - 空 REDIRECT 不 要 の 場 合 は 以 下 を 指 定 する /CatalogueService/csw/edit/dummy.jsp METADATAURL * メタデータの URL 登 録 するメタデータの URL(XML) DISASTERTYPE OPENMODE 災 害 区 分 以 下 のいずれか 1: 地 震 2: 津 波 高 潮 3: 火 山 4: 風 水 5: 土 砂 6: 氷 雪 7:その 他 公 開 設 定 以 下 のいずれか 0: 常 に 公 開 1:ログインユーザに 公 開 -1: 非 公 開 地 図 データが 対 象 とする 災 害 の 区 分 を 指 定 する 対 象 の 災 害 区 分 を 特 定 しない 場 合 は 指 定 しなくてもよ い メタデータの 公 開 範 囲 を 設 定 する 常 に 公 開 はクリアリングハウスへのログインの 有 無 にか かわらず 全 て 利 用 者 がアクセス 可 能 なメタデータ ログインユーザに 公 開 はクリアリングハウスにログイン 中 の 利 用 者 のみアクセス 可 能 なメタデータ 非 公 開 はメタデータの 登 録 者 または 管 理 者 でログイン 中 のみアクセス 可 能 なメタデータ 8

9 4. メタデータ 更 新 API 3. メタデータ 登 録 API のメタデータ 登 録 API を 利 用 してメタデータの 更 新 が 可 能 である 0. クリアリングハウスにメタデータを 登 録 するには 予 めクリアリングハウスにメタデータ 登 録 権 限 を 持 つユーザでログイン している 必 要 がある ログインについては 7.クリアリングハウス 認 証 API を 参 照 メタデータのファイルを 送 る 場 合 の 場 合 は METADATAFILE で 指 定 したメタデータのファイル 識 別 子 (fileidentifier 項 目 の 値 )と 同 じものが 登 録 済 みの 場 合 は 更 新 となる 3.2. クリアリングハウスがメタデータを 参 照 して 登 録 させることを 行 う 場 合 の 場 合 は METADATAURL で 指 定 したメ タデータのファイル 識 別 子 (fileidentifier 項 目 の 値 )と 同 じものが 登 録 済 みの 場 合 は 更 新 されるものとする メタデータを 更 新 するには 予 めクリアリングハウスに 更 新 対 象 のメタデータの 登 録 を 行 なったユーザまたは 管 理 者 でログ インしている 必 要 がある ログインについては 7 クリアリングハウス 認 証 API を 参 照 9

10 5. メタデータ 削 除 API メタデータを 削 除 するには 予 めクリアリングハウスに 削 除 対 象 のメタデータの 登 録 を 行 なったユーザまたは 管 理 者 でログ インしている 必 要 がある ログインについては 7 クリアリングハウス 認 証 API を 参 照 METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 SERVICE * CSW 固 定 VERSION * 固 定 REQUEST * DeleteMetadata 固 定 REDIRECTURL * リダイレクト 先 URL 削 除 後 に REDIRECT するページの URL を 指 定 する この URL には パラメータ FILEIDENTIFIER が 渡 される パラメータの 値 は 以 下 の 通 り 削 除 成 功 - 削 除 したメタデータのファイル 識 別 子 削 除 失 敗 - 空 REDIRECT 不 要 の 場 合 は 以 下 を 指 定 する /CatalogueService/csw/edit/dummy.jsp FILEIDENTIFIER * ファイル 識 別 子 削 除 するメタデータのファイル 識 別 子 (メタデータ 項 目 fileidentifier の 値 ) 10

11 6. クリアリングハウス 検 索 API 6.1. 条 件 検 索 (CSW 準 拠 ) OGC CSW GetRecords リクエストに 準 拠 した API このリクエストはパラメータではなく 以 下 の 形 式 の XML のテキストを POST する XML テキストの 文 字 エンコーディングは UTF-8 とする METHOD: POST(applicationi/x-www-form-urlencoded) タグ/ 属 性 値 説 明 GetRecords タグ - - service 属 性 CSW 固 定 version 属 性 固 定 resulttype 属 性 レスポンスの 形 式 hits/results/validate のいずれか outputformat 属 性 application/xml レスポンス ドキュメントの MIME タイプ 固 定 outputschema 属 性 出 力 スキーマの URI または startposition 属 性 取 得 レコード 先 頭 位 置 デフォルト 値 :1 ngis.net/cat/csw/2.0.2 maxrecords 属 性 最 大 取 得 レコード 数 デフォルト 値 :10 最 大 値 :100 Query タグ - - typename 属 性 gmd:md_metadata 固 定 ElementSetName タグ - typename 属 性 結 果 セットの 形 式 brief/summay/full のいずれか Constraint タグ - - version 属 性 固 定 ogc:filter タグ 検 索 条 件 OGC Filter Encoding 仕 様 ( spatial.org/standards/filter)に 準 拠 した 条 件 各 タグの 仕 様 については OpenGIS Catalogue Services Specification 2.0.2( /standards/specifications/catalog) を 参 照 ogc:filter に 設 定 できる 検 索 項 目 とメタデータの 検 索 対 象 項 目 の 対 応 は 以 下 の 通 り 検 索 項 目 検 索 項 目 名 メタデータの 対 象 項 目 (XPath) タイトル Title /MD_Metadata/identificationInfo/MD_DataIdentification/citation/title 要 約 Abstract /MD_Metadata/identificationInfo/MD_DataIdentification/abstract キーワード AnyText /MD_Metadata/identificationInfo/MD_DataIdentification/descriptiveKe 11

12 ywords/md_keywords/jmp:keyword および /MD_Metadata/identificationInfo/MD_DataIdentification/abstract メタデータ 更 新 日 Modified /MD_Metadata/dateStamp ID Identifier /MD_Metadata/fileIdentifier 範 囲 BoundingBox 以 下 の4つの 要 素 で 構 成 される 緯 度 経 度 矩 形 との 交 差 /MD_Metadata/identificationInfo/MD_DataIdentification/extent/geogr aphicelement/ex_geographicboundingbox/westboundlongitude /MD_Metadata/identificationInfo/MD_DataIdentification/extent/geogr aphicelement/ex_geographicboundingbox/southboundlongitude /MD_Metadata/identificationInfo/MD_DataIdentification/extent/geogr aphicelement/ex_geographicboundingbox/eastboundlongitude /MD_Metadata/identificationInfo/MD_DataIdentification/extent/geogr aphicelement/ex_geographicboundingbox/northboundlongitude 以 下 に XML テキストの 記 述 例 を 示 す タイトル(Title)を 検 索 条 件 とした 場 合 の 例 <?xml version="1.0" encoding="utf-8"?> <GetRecords xmlns=" xmlns:ogc=" service="csw" version="2.0.2" resulttype="results" outputformat="application/xml" outputschema=" startposition="1" maxrecords="10"> <Query typenames="gmd:md_metadata"> <ElementSetName typenames="">full</elementsetname> <Constraint version="1.1.0"> <ogc:filter> <ogc:propertyislike escape="\" singlechar="_" wildcard="%"> <ogc:propertyname>title</ogc:propertyname> <ogc:literal>% 地 震 %</ogc:literal> </ogc:propertyislike> </ogc:filter> </Constraint> </Query> </GetRecords> 12

13 6.2. 条 件 検 索 ( 独 自 REST 形 式 ) 簡 便 性 や 検 索 方 法 の 拡 張 のために REST 形 式 の API を 用 意 する 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 SERVICE * CSW 固 定 VERSION * 固 定 REQUEST * GetRecords 固 定 resulttype * results 固 定 outputformat * application/xml 固 定 outputschema * 固 定 /2.0.2 ElementSetName * 結 果 セットの 形 式 brief/summay/full のいずれか startposition 取 得 レコード 先 頭 位 置 デフォルト 値 :1 maxrecords 最 大 取 得 レコード 数 デフォルト 値 :10 最 大 値 :100 DISASTERTYPE 以 下 のいずれかの 番 号 災 害 区 分 カンマ 区 切 りで 複 数 指 定 可 能 1: 地 震 2: 津 波 高 潮 3: 火 山 4: 風 水 5: 土 砂 6: 氷 雪 7:その 他 KEYWORD 文 字 列 AND キーワード スペース 区 切 りで 複 数 指 定 可 能 部 分 一 致 KEYWORDOR 文 字 列 OR キーワード スペース 区 切 りで 複 数 指 定 可 能 部 分 一 致 KEYWORDNOT 文 字 列 NOT キーワード スペース 区 切 りで 複 数 指 定 可 能 部 分 一 致 FUZZYSEARCH true(する)/ false(しない) あいまい 検 索 制 御 CONTACTNAME 文 字 列 問 い 合 わせ 先 の 名 称 に 対 する 検 索 条 件 部 分 一 致 空 白 文 字 で 区 切 って 複 数 指 定 可 能 複 数 指 定 した 場 合 は 全 ての 文 字 列 に 部 分 一 致 す るものを 検 索 する 13

14 CONTACTCITY 文 字 列 問 い 合 わせ 先 の 市 区 町 村 名 に 対 する 検 索 条 件 部 分 一 致 空 白 文 字 で 区 切 って 複 数 指 定 可 能 複 数 指 定 した 場 合 は 全 ての 文 字 列 に 部 分 一 致 するものを 検 索 する CONTACTADMINAREA 文 字 列 問 い 合 わせ 先 の 都 道 府 県 名 に 対 する 部 分 一 致 空 白 文 字 で 区 切 って 複 数 指 定 可 能 複 数 指 定 した 場 合 は 全 ての 文 字 列 に 部 分 一 致 するも のを 検 索 する USELIMITATION 文 字 列 利 用 上 の 制 約 に 対 する 検 索 条 件 部 分 一 致 空 白 文 字 で 区 切 って 複 数 指 定 可 能 複 数 指 定 した 場 合 は 全 ての 文 字 列 に 部 分 一 致 するものを 検 索 する 但 し コード(001 等 3 桁 の 数 字 )が 指 定 された 場 合 は 完 全 一 致 BBOX 西 側 経 度, 南 側 緯 度, 東 側 経 度, 北 地 理 範 囲 条 件 度 単 位 側 緯 度 TERMTYPE 以 下 のいずれかの 番 号 期 間 条 件 の 対 象 カンマ 区 切 りで 複 数 指 定 可 能 1: 作 成 日 2: 刊 行 日 3: 改 訂 日 TERM 開 始 日 付, 終 了 日 付 期 間 条 件 開 始 日 と 終 了 日 のカンマ 区 切 り 一 方 を 省 略 可 能 省 略 すると 片 側 無 制 限 DATATERM 開 始 日 付, 終 了 日 付 データの 期 間 条 件 開 始 日 と 終 了 日 のカンマ 区 切 り 一 方 を 省 略 可 能 省 略 すると 片 側 無 制 限 RATING 最 低 値, 最 高 値 評 価 条 件 最 低 値 と 最 高 値 のカンマ 区 切 り 値 は 0~5 一 方 を 省 略 可 能 省 略 すると 片 側 無 制 限 RESOURCEURL 文 字 列 データアクセス URL に 対 する 検 索 条 件 部 分 一 致 空 白 文 字 で 区 切 って 複 数 指 定 可 能 複 数 指 定 した 場 合 は 全 ての 文 字 列 に 部 分 一 致 するも のを 検 索 する APPLICATIONPROFILE WMS,WFS,WCS のいずれかを 指 定 データ 提 供 サービスの 種 類 を 条 件 として 検 索 カ ンマ 区 切 りで 複 数 指 定 可 能 INCLUDEPLANNED 以 下 のいずれかを1つ 指 定 する TRUE: 予 定 メタデータを 含 む 全 て FALSE: 予 定 メタデータを 含 まない ONLY: 予 定 メタデータのみ 検 索 対 象 に 予 定 メタデータを 含 むかどうかを 指 定 する 14

15 ORDERBY 以 下 のいずれかの 番 号 1つ 並 べ 替 え 方 法 デフォルト 値 :10 1: 更 新 日 付 2:アクセス 数 3: 評 価 5: 検 索 条 件 との 関 連 度 10:ID 昇 順 11:ID 降 順 12:メタデータ 更 新 日 時 昇 順 13:メタデータ 更 新 日 時 降 順 enc 文 字 エンコーディング 値 の 文 字 エンコーディングを 指 定 デフォルトは EUC-JP 15

16 6.3. 個 別 メタデータ 取 得 (CSW 準 拠 ) OGC CSW GetRecordById リクエストに 準 拠 した API このリクエストはパラメータではなく 以 下 の 形 式 の XML のテキストを POST する XML テキストの 文 字 エンコーディングは UTF-8 とする METHOD: POST(applicationi/x-www-form-urlencoded) タグ/ 属 性 値 説 明 GetRecordById タグ - - service 属 性 CSW 固 定 version 属 性 固 定 resulttype 属 性 レスポンスの 形 式 hits/results/validate のいずれか outputformat 属 性 application/xml outputschema 属 性 出 力 スキーマの URI レスポンス ドキュメントの MIME タイプ 固 定 または ElementSetName タグ - - typename 属 性 結 果 セットの 形 式 brief/summay/full のいずれか Id タグ メタデータのファイル 識 別 子 メタデータの fileidentifier 要 素 の 値 各 タグの 仕 様 については OpenGIS Catalogue Services Specification を 参 照 XML データの 記 述 例 を 以 下 に 示 す ファイル 識 別 子 = NIED_JMP_33 のメタデータを 取 得 する 例 <?xml version="1.0" encoding="utf-8"?> <GetRecordById xmlns=" xmlns:ogc=" service="csw" version="2.0.2" resulttype="results" outputformat="application/xml" outputschema=" <ElementSetName>full</ElementSetName> <Id>NIED_JMP_33</Id> </GetRecordById> 16

17 6.4. 個 別 メタデータ 取 得 ( 独 自 REST 形 式 ) 簡 便 性 や 検 索 方 法 の 拡 張 のために REST 形 式 の API を 用 意 する 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 SERVICE * CSW 固 定 VERSION * 固 定 REQUEST * GetRecordById 固 定 outputformat * application/xml 固 定 outputschema * 出 力 スキーマの URI または ElementSetName * 結 果 セットの 形 式 brief/summay/full のいずれか Id * メタデータのファイル 識 別 子 メタデータの fileidentifier 要 素 の 値 17

18 7. クリアリングハウス 認 証 API 7.1. ログイン クリアリングハウスにログインすると 以 下 のことが 可 能 になる ログインユーザに 公 開 されているメタデータへのアクセス( 検 索 および 取 得 ) メタデータ 登 録 権 限 がある 場 合 はメタデータの 登 録 ログインユーザによって 登 録 されたメタデータの 更 新 削 除 クリアリングハウスにログインするには 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 REQUEST * AuthAccount 固 定 LOGINNAME * ログイン 名 ログインするユーザのログイン 名 PASSWORD * パスワード ログインするユーザのパスワード RESPONSE * JSON 固 定 ログイン 結 果 は 以 下 の JSON(mime-type:applicatio n/json) 形 式 の 文 字 列 で 返 される { "code":ログイン 結 果 } ログイン 結 果 0: ログイン 成 功 0 以 外 :ログイン 失 敗 7.2. ログアウト ログイン 済 みのクリアリングハウスからログアウトするには 以 下 のリクエストを 送 信 する(*は 必 須 パラメータ) ログインしていない 状 態 でこのリクエストを 送 信 しても 何 もせず エラーにもならない METHOD: GET または POST(applicationi/x-www-form-urlencoded) パラメータ 値 説 明 REQUEST * Logout 固 定 RESPONSE * JSON 固 定 ログアウト 結 果 は 以 下 の JSON(mime-type:applicati on/json) 形 式 の 文 字 列 で 返 される { "code":ログアウト 結 果 } ログアウト 結 果 0: ログアウト 成 功 (ログアウトは 失 敗 しない) 18