Ｇ空間情報センター　ＡＰＩ利用マニュアル
２０１８年５月　一般社団法人社会基盤情報流通推進協議会

内容

1.共通連携基盤（ＡＰＩ）とは

2. API キーおよびID の確認
2-1.ユーザAPI キーおよびユーザＩＤの確認
2-2.組織ID の確認
2-3.カテゴリＩＤの確認
2-4.データセットＩＤの確認
2-5.リソースＩＤの確認

3.ＡＰＩの一覧

4.ＡＰＩの利用例
4.1.API を利用した情報の取得例
（ア）組織に関するメタデータの取得
（イ）カテゴリに関するメタデータの取得
（ウ）タグに関するメタデータの取得
（エ）データセットやリソースに関するメタデータの取得
（オ）フォロー機能に関するメタデータの取得
（カ）ダッシュボードに関するメタデータの取得
（キ）ＣＫＡＮの設定に関するメタデータの取得
4-2 プライベートデータのメタデータ取得
4-3 API を利用した登録、更新、削除例
（ア）データセットに関する更新
（イ）リソースおよびリソースビューに関する更新
（ウ）フォローに関する更新

1.共通連携基盤（ＡＰＩ）とは

G 空間情報センターではシステム連携を実現するため、各システムから共通で使用可能なG空間情報センター側の共通連携基盤（API）（以降、API）を実装しています。API は、URL+引数で構成されています。一例として、ブラウザ上でAPI のURL を指定すると、実行結果が表示されます。

2. API キーおよびID の確認

2-1.ユーザAPI キーおよびユーザＩＤの確認

Ｇ空間情報センターではユーザごとにAPI キーを保持しています。API には情報取得機能と情報編集機能があり、プライベートデータセットの情報取得には閲覧権限のあるユーザのＡＰＩキーが必要となり、情報編集には編集権限のあるユーザのAPI キーが必要となります。
以下のURL を入力してユーザプロパティ画面を開き、画面左下に記載されているユーザ別のAPI キーを確認します。
https://www.geospatial.jp/ckan/user/<ユーザ名>
また、ユーザ名＝ユーザID として、ユーザID を引数に指定するＡＰＩが利用できます。

2-2.組織ＩＤの確認

ＡＰＩの引数に指定する組織ＩＤは組織情報表示時のＵＲＬで確認します。

2-3.カテゴリＩＤの確認

ＡＰＩの引数に指定するカテゴリＩＤは、カテゴリ情報表示時のＵＲＬで確認します。

2-4.データセットＩＤの確認

ＡＰＩの引数に指定するデータセットＩＤは、データセット情報表示時のＵＲＬで確認します。

2-5.リソースＩＤの確認

ＡＰＩの引数に指定するリソースＩＤは、リソース情報表示時のＵＲＬで確認します。

3.ＡＰＩの一覧

Ｇ空間情報センターで提供されるＡＰＩの一覧です。

4.ＡＰＩの利用例

G 空間情報センターのCKANAPI のベースURL は以下の通りです。
https://www.geospatial.jp/ckan/api/3/action/

4.1.API を利用した情報の取得例

（ア）組織に関するメタデータの取得

・登録されている組織の一覧
https://www.geospatial.jp/ckan/api/3/action/organization_list

・登録されている組織の一覧(各組織のメタ情報も取得）
https://www.geospatial.jp/ckan/api/3/action/organization_list?all_fields=true

・登録されている組織の一覧（各組織のメタ情報を取得し、且つ組織のデータセット登録数順でソート）
https://www.geospatial.jp/ckan/api/3/action/organization_list?all_fields=true&order_by=packages

・指定した組織の詳細情報（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_show?id=aigid

・組織更新履歴を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_activity_list?id=aigid

・組織のリビジョン履歴を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_revision_list?id=aigid

・検索文字列に一致する組織の一覧を取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_autocomplete?q=aigid

・組織の更新履歴をhtml 形式で取得する（例.一般社団法人社会基盤情報流通推進協議会)
https://www.geospatial.jp/ckan/api/3/action/organization_activity_list_html?id=aigid

（イ）カテゴリに関するメタデータの取得

・登録されているカテゴリの一覧
https://www.geospatial.jp/ckan/api/3/action/group_list

・指定したカテゴリの詳細情報（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_show?id=gr-0100

・グループ更新履歴を取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_activity_list?id=gr-0100

・編集権限をもつカテゴリの一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/group_list_authz

・グループのリビジョン履歴を取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_revision_list?id=gr-0100

・カテゴリの更新履歴をhtml 形式で取得する（例.国土・気象)
https://www.geospatial.jp/ckan/api/3/action/group_activity_list_html?id=gr-0100

（ウ）タグに関するメタデータの取得

・タグの一覧
https://www.geospatial.jp/ckan/api/3/action/tag_list

・指定したタグ「全国」を含むデータセット名の一覧（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/package_search?q=*:*&facet.limit=10&facet.field=[“title_string”]&fq=tags:全国&rows=0

・指定したタグ「全国」を含むカテゴリの検索（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/package_search?q=*:*&facet.limit=10&facet.field=[“groups”]&fq=tags:全国&rows=0

・キーワード「全国」を含むタグの検索
https://www.geospatial.jp/ckan/api/3/action/tag_search?query=全国

・検索文字列「全国」に一致するタグの一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/tag_autocomplete?q=全国

（エ）データセットやリソースに関するメタデータの取得

・データセット一覧(リソースを含む)を取得する
https://www.geospatial.jp/ckan/api/3/action/current_package_list_with_resources

・検索条件に合うデータセット「AED」とそのデータセットに含まれるリソースの一覧
https://www.geospatial.jp/ckan/api/3/action/package_search?q=name:*aed*

・指定したデータセット「AED」のメタデータ情報
https://www.geospatial.jp/ckan/api/3/action/package_show?id=aed

・指定したリソース「全国AED 設置位置」のメタデータ情報
https://www.geospatial.jp/ckan/api/3/action/resource_show?id=bfc3b8da-073a-4e3b-98c7-ff2f40edb621

・「name」属性にキーワード「全国」を含むリソースの検索（10 件取得指定）
https://www.geospatial.jp/ckan/api/3/action/resource_search?query=name:全国&limit=10

・データセット更新履歴を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_activity_list?id=aed

・データセットのリビジョン履歴を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_revision_list?id=aed

・指定したデータセットと他のデータセットとの関係の一覧を取得する（例．AED と避難場所）
https://www.geospatial.jp/ckan/api/3/action/package_relationships_list?id=aed&id2=hinanbasho

・リソースビューの詳細を取得する(リソースビューのID を指定する）
https://www.geospatial.jp/ckan/api/3/action/resource_view_show?id=e7deded5-2efc-4833-8d0f-c52016a86f3f

・特定リソースのリソースビューの一覧を取得する(リソースのID を指定する）
https://www.geospatial.jp/ckan/api/3/action/resource_view_list?id=2a5afb18-9a08-44bc-929d-ce891ea791e8

・検索文字列に一致するデータセットの一覧を取得する（例．AED）
https://www.geospatial.jp/ckan/api/3/action/package_autocomplete?q=aed

・検索文字列に一致する拡張子の一覧を取得する（例．csv）
https://www.geospatial.jp/ckan/api/3/action/format_autocomplete?q=csv

（オ）フォロー機能に関するメタデータの取得

・指定したユーザのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/user_follower_count?id=[user]

・指定したデータセットのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_follower_count?id=aed

・指定したカテゴリのフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/group_follower_count?id=gr-0100

・指定した組織のフォロワー人数を取得する
https://www.geospatial.jp/ckan/api/3/action/organization_follower_count?id=aigid

・指定したデータセットのフォロー状況を取得する
https://www.geospatial.jp/ckan/api/3/action/am_following_dataset?id=aed

・指定したカテゴリのフォロー状況を取得する
https://www.geospatial.jp/ckan/api/3/action/am_following_group?id=gr-0100

・指定したユーザがフォローしている数を取得する
https://www.geospatial.jp/ckan/api/3/action/followee_count?id=[user]

・指定したユーザがフォローしているデータセット数を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_followee_count?id=[user]

・指定したユーザがフォローしているカテゴリ数を取得する
https://www.geospatial.jp/ckan/api/3/action/group_followee_count?id=[user]

・指定したユーザのフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/followee_list?id=[user]

・指定したユーザのデータセットフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/dataset_followee_list?id=[user]

・指定したユーザのグループフォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/group_followee_list?id=[user]

・指定したユーザの組織フォロー一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/organization_followee_list?id=[user]

（カ）ダッシュボードに関するメタデータの取得

・ダッシュボードの更新履歴の一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_activity_list

・ダッシュボードの更新履歴の一覧をhtml 形式で取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_activity_list_html

・ダッシュボード内の新着数を取得する
https://www.geospatial.jp/ckan/api/3/action/dashboard_new_activity_count

（キ）ＣＫＡＮの設定に関するメタデータの取得

・サイトのリビジョン履歴を取得する
https://www.geospatial.jp/ckan/api/3/action/revision_list

・リビジョンの詳細を取得する(リビジョンID を指定）
https://www.geospatial.jp/ckan/api/3/action/revision_show?id=21a4831e-68b3-4b87-80a2-109360005b72

・CKAN の設定情報と拡張機能の一覧を取得する
https://www.geospatial.jp/ckan/api/3/action/status_show

・指定した更新情報の詳細を取得する(リビジョンID を指定）
https://www.geospatial.jp/ckan/api/3/action/activity_detail_list?id=9d453869-9706-4096-93d5-67421fb17cbc

・指定したAPI のヘルプを取得する（API 名を指定する）
https://www.geospatial.jp/ckan/api/3/action/help_show?name=revision_show

・CKAN の設定情報を取得する
https://www.geospatial.jp/ckan/api/3/action/config_option_list

・指定したCKAN 設定情報の詳細を取得する（設定情報をキーにする）
https://www.geospatial.jp/ckan/api/3/action/config_option_show?key=ckan.site_description

4-2 プライベートデータのメタデータ取得

プライベートデータの情報を取得する場合は、閲覧権限のあるユーザのAPI キーが必要となります。API キーを使用する場合はcurl コマンドを用い、オプションは以下のように設定します。curl コマンドはwindows のコマンドプロンプト（curl のインストールが必要）やlinuxOS 上で使用します。

引数の指定
-d ‘{“引数1″:”値1″,”引数2″:”値2″,”引数3″:”値3”,,,}’
API キーの指定
-H “X-CKAN-API-Key:<API キー>”

curl https://www.geospatial.jp/ckan/api/3/action/resource_show -d'{“id”:”値”}’ -H “XCKAN-API-Key:<API キー>“
4

4-3 API を利用した登録、更新、削除例

データの登録、更新、削除 は編集権限を持つユーザのAPI キーが必要となります。
API キーを使用する場合はcurl コマンドを用います。curl コマンドはwindows のコマンドプロンプト（curl のインストールが必要）やlinuxOS 上で使用します。コマンドオプションは以下のように設定します。

引数の指定
-d ‘{“引数1″:”値1″,”引数2″:”値2″,”引数3″:”値3”,,,}’
API キーの指定
-H “X-CKAN-API-Key:<API キー>”

（ア）データセットに関する更新

・新規データセットを作成する
curl https://www.geospatial.jp/ckan/api/3/action/package_create -d ‘{“name”:”値”,”private”,”true”,”owner_org”:”値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のデータセットを更新する
curl https://www.geospatial.jp/ckan/api/3/action/package_update -d ‘{“id”:”値”,”name”:”値”}’ -H “X-CKAN-API-Key:<API キー>“
注意事項：ＡＰＩ経由でデータセットを更新すると、配下のリソースが削除されます。また、データセット作成時に入力していたパラメータ値が未設定の場合、それらのパラメータ値はnull となります。

・特定のデータセットを削除する
curl https://www.geospatial.jp/ckan/api/3/action/package_delete -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

（イ）リソースおよびリソースビューに関する更新

・新規リソースを作成する
curl https://www.geospatial.jp/ckan/api/3/action/resource_create -d ‘{“packageid”:”値”,”url”,”値”}’ -H “X-CKAN-API-Key:<API キー>“

・新規リソースビューを作成する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_create -d ‘{“resource_id”:”値”,”title”,”値”,”view_type”:”値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のリソースを更新する
curl https://www.geospatial.jp/ckan/api/3/action/resource_update -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のリソースビューを更新する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_update -d ‘{“id”:”値”}’-H “X-CKAN-API-Key:<API キー>“

・特定のリソースを削除する
curl https://www.geospatial.jp/ckan/api/3/action/resource_delete -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のリソースビューを削除する
curl https://www.geospatial.jp/ckan/api/3/action/resource_view_delete -d ‘{“id”:”値”}’-H “X-CKAN-API-Key:<API キー>“

（ウ）フォローに関する更新

・特定のユーザをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_user -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のデータセットをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_dataset -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のカテゴリをフォローする
curl https://www.geospatial.jp/ckan/api/3/action/follow_group -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のユーザのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_user -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のデータセットのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_dataset -d ‘{“id”:”値”}’ -H “X-CKAN-API-Key:<API キー>“

・特定のカテゴリのフォローを中止する
curl https://www.geospatial.jp/ckan/api/3/action/unfollow_group -d ‘{“id”:” 値”}’ -H “X-CKAN-API-Key:<API キー>“

使い方（マニュアル）