ながさきAPIカタログサイト
利用者向けマニュアル
長崎県デジタル戦略課
版数 第 1.2 版1本 編
目次
1.ながさき API カタログサイト概要 ............................................................ 2
2.利用の開始............................................................................. 2
2-1.利用申請について ................................................................... 2
2-2.ご利用にあたっての注意.............................................................. 3
2-3.ログイン............................................................................ 3
2-4.ホーム画面......................................................................... 3
2-5.Catalog 画面 ....................................................................... 4
1 検索(Search) ................................................................... 4
2 カテゴリ(Category)の選択......................................................... 5
3 タイトルロゴ ..................................................................... 5
3.API の利用手順 ......................................................................... 6
3-1.API 仕様確認画面へのアクセス方法 .................................................... 6
1 API ドキュメント詳細ページへのアクセス方法 ......................................... 6
2 データモデル PDF へのアクセス方法 ................................................ 8
3-2.API 仕様の確認方法 ................................................................. 9
1 REST 形式(データ種類毎) ........................................................ 9
2 NGSIv2 形式の(データ種類共通) ................................................. 10
3-3.API のテスト実行 ................................................................... 12
4.利用規約.............................................................................. 132本 編
本編
1.ながさき API カタログサイト概要
ながさき API カタログサイト(以下本サイトと呼びます)は、「つながる長崎」データ連携基盤が公開する API
の利用方法を API 利用者(開発者)向けに提示するサイトです。公開 API 一覧、API の利用方法、API で用
いるデータモデルを提示します。本書では、本サイトの利用方法について記載します。
2.利用の開始
本サイトの利用を開始する方法と機能を記載します。
2-1.利用申請について
公開 API・ながさき API カタログサイトの利用をご希望の方は、利用申請が必要になります。
下記 URL より利用申請を行ってください。
※(注記)公開 API・ながさき API カタログサイトの利用にあたっては、4 章の利用規約をご確認の上、ご利用く
ださい。
◼ ながさき API カタログサイト 利用申請フォーム(長崎県電子申請システム):
https://s-kantan.jp/pref-nagasaki-u/offer/offerList_detail.action?tempSeq=1194
申請受付後、ID の登録処理を行い、入力したメールアドレス宛てに下記の項目が通知されます。
 ながさき API カタログサイト URL
 API キー
図 1:ながさき API カタログサイト利用申請フォーム
※(注記)2次元バーコードはこちら
図 1:ながさき API カタログサイト利用申請フォーム3本 編
2-2.ご利用にあたっての注意
本サイトは暗号化通信 https(SSL:ポート 443)通信によるご利用となります。
2-3.ログイン
2-4.ホーム画面
利用申請完了時の配信メールに記載されている URL へアクセス後、ホーム画面が表示されます。
ホーム画面の各機能(図 2 の赤枠1〜5)は下記になります。
1 Catalog
Catalog 画面に遷移し、利用可能な API カタログの一覧を参照可能です。
詳細な利用方法は「2-5.Catalog 画面」をご参照ください。
2 管理者用
管理者用のログインページに遷移します。
API カタログサイトについては、ログイン不要でご利用になれます。
3 利用申請
「2-1.利用申請について」に記載の「ながさき API カタログサイト 利用申請フォーム(長崎県電子
申請システム)」へ遷移します。
4 ながさき API カタログ利用マニュアル
本マニュアルを参照可能です。
5 公開 API 利用マニュアル
公開 API 利用マニュアルを参照可能です。
公開されている API に関する共通仕様が記載されています。
図 2:ホーム画面4本 編
2-5.Catalog 画面
右上の Catalog ボタンを押下することで API カタログの一覧を参照可能です。
本サイトを利用するにあたり、Catalog 画面の各機能(図 4 の赤枠1〜3)を以下に記載します。
1 検索(Search)
テキスト入力による検索が可能です。検索対象はドキュメントのタイトル・説明文(図 4 赤枠)
となります。
図 3:Catalog 画面
図 4:API ドキュメントタイトル・説明文5本 編
2 カテゴリ(Category)の選択
カテゴリ選択による絞り込みが可能です。
初期表示では全てのカテゴリが選択された状態(図 5)となっています。
3 タイトルロゴ
ホーム画面へ遷移します。
図 5:カテゴリフィルター6本 編
3.API の利用手順
API の利用手順を記載します。
3-1.API 仕様確認画面へのアクセス方法
1 API ドキュメント詳細ページへのアクセス方法
➢ REST 形式(データ種類毎)
ホーム画面から API ドキュメント詳細ページへアクセスするには、仕様を確認したい API ドキュメ
ントを選択します。ここでは例として、REST 形式で取得可能な「観光_観光施設情報一覧 API」
(図 6 赤枠)を選択します。
API ドキュメントを選択すると、REST 形式の API ドキュメント詳細ページ(図 7)に遷移します。仕
様の確認方法は「3-2.API 仕様の確認方法」をご参照ください。
図 6:API ドキュメント選択画面
図 7: API ドキュメント詳細ページ(REST)7本 編
➢ NGSIv2 形式(データ種類共通)
NGSIv2 形式の API ドキュメント詳細ページへアクセスするには、フィルターより「NGSI」を選択し、
「FIWARE-NGSIv2API」(図 8 の赤枠)を選択します。
API ドキュメントを選択すると、NGSIv2 形式の API ドキュメント詳細ページ(図 10)に遷移します。
仕様の確認方法は次節で記載します。
図 8:REST 形式の API ドキュメント詳細ページ
図 9:API ドキュメント詳細ページ(NGSIv2)
図 8:API ドキュメント(NGSIv2)選択画面8本 編
2 データモデル PDF へのアクセス方法
NGSI v2API 形式の API ドキュメント詳細のページでで、図 11 の赤枠「データモデル設計書」を選択
します。PDF が表示され、NGSIv2 で指定するデータ種類毎のパラメータ情報等についての確認が
可能です。
図 10:データモデル PDF 選択画面9本 編
3-2.API 仕様の確認方法
ここでは、API 仕様の確認方法について、REST 形式(データ種類毎)の API ドキュメント詳細ページと
NGSIv2 形式(データ種類共通)の API ドキュメント詳細ページのそれぞれについて記載します。
1 REST 形式(データ種類毎)
「観光_観光施設情報一覧 API」の API ドキュメント詳細ページを例に API 仕様の確認方法を記載し
ます。API 仕様を確認するには、図 11 の赤枠を選択します。
図 11 の赤枠を選択すると、下部に詳細(図 12)が表示されます。
 図 12 の赤枠1では、API 実行に必要な情報・仕様等を確認することが可能です。また、API の
テスト実行をすることが可能です。テスト実行の方法については、「3-3.API のテスト実行」をご
参照ください。
 図 12 の赤枠2では、言語別のコードスニペット※(注記)の確認が可能です。
図 11:API ドキュメント詳細ページ(REST 形式) 1
図 12:API ドキュメント詳細ページ(REST 形式) 210本 編
※(注記):コードスニペットは再利用可能なソースコードの断片という意味で、ここではリクエストサンプル
(利用者がどのように API を呼び出して使用することができるか)を示します。コードスニペット
を利用することで、API の呼び出しプログラムを容易に実装することが可能です。
2 NGSIv2 形式の(データ種類共通)
「FIWARE-NGSIv2API」 の API ドキュメント詳細ページでの API 仕様の確認方法を記載します。API
仕様を確認するには、ここでは例として図 14 赤枠内を選択します。
図 13:コードスニペット確認画面
図 14:API ドキュメント詳細ページ(NGSIv2 形式) 111本 編
図 14 赤枠を選択すると、下部に詳細(図 15)が表示されます。
 図 15 赤枠1では、API 実行に必要な情報・仕様等を確認することが可能です。NGSIv2 で指
定するデータ種類毎のパラメータ情報等については、「データモデル設計書」をご参照ください。
 図 15 の赤枠1では、API のテスト実行をすることが可能です。テスト実行の方法については、
テスト実行の方法については、「3-3.API のテスト実行」をご参照ください。
 図 15 の赤枠2では、コードスニペットの確認が可能です。
図 15:API ドキュメント詳細ページ(NGSIv2 形式) 212本 編
3-3.API のテスト実行
ここではテスト実行の方法を記載します。テスト実行には利用申請完了時に配信された API キーの
認証が必要となります。ここでは、REST 形式で取得可能な「観光_観光施設情報一覧 API」のテスト
実行例を記載します。なお、NGSIv2 形式のテスト実行も同様の手順となります。
 API ドキュメント詳細ページより、「Try it out」(図 16 赤枠)を選択します。
 「Triy it out」を選択すると、API キー認証画面が表示されます。
図 17 の赤枠1に API キーを入力し、「Execute」(図 17 赤枠2)を選択します。
Execute 選択後、レスポンス結果が図 17 の赤枠3に表示されます。
図 16:Try it out 選択画面
図 17:API キー認証画面13本 編
4.利用規約
公開 API・ながさき API カタログサイトの利用にあたっては、以下、利用規約をご確認の上、ご利用ください。
「ながさき API カタログサイト利用規約」(以下「本規約」という。)は、長崎県(以下「本県」という。)が運用管
理を行うウェブサイト「ながさき API カタログサイト」において提供する API 機能(以下「本機能」という。)を適
正に利用していただき、また、有効に活用していただくために遵守していただく事項を掲載しています。
1.本規約について
(1)本機能の利用をもって本規約の内容を承諾したものとみなします。
(2)本規約の内容は、予告なしに変更することがありますので、本機能の利用に際しては、本規約の最新
の内容を確認してください。
2.利用登録について
(1)本機能は、利用登録をした方(以下「利用者」という。)のみ利用することができます。
3.サイトへのログイン情報について
(1)本県は、前条の利用登録完了後、本サイトを利用するためのログイン情報を通知します
(2)利用者は、通知を受けたログイン情報を、第三者に譲渡・貸与してはならないものとします。
4.利用状況の情報提供について
(1)本県は、本機能の利用状況について、利用者にアンケートやその他の方法により聴取することがありま
す。その際、利用者は、開示可能な範囲で情報を提供するものとします。
(2)本県は、提供された情報について、活用事例として公開することがあります。
5.本機能の提供条件について
(1)本機能は、予告なく、本機能の停止、性能の劣化等が発生することがあります。
(2)本県は、利用者への事前の通知をすることなく、本機能の停止、仕様の変更を行うことができるものとし
ます。
(3)本県は、本機能の負荷状況に応じてアクセス制限をかけることがあります。
6.クレジットの表示について
(1)利用者は、本機能を利用したサービスを提供する場合には、下記のクレジット表示をお願いします。
「このサービスは、「ながさき API カタログサイト」の API 機能を使用していますが、サービスの内容は長
崎県によって保証されたものではありません。」
なお、利用される方が参照できる場所であれば、表示場所の指定はありません。14本 編
7.アクセス情報の収集について
(1)本県は、分析と改善のために本機能への利用者のアクセス情報を記録しています。
(2)利用者のアクセス情報は「IP アドレス、ホスト名」等の情報を含んでいますが、個人を特定できる情報は
一切含まれておりません。
(3)アクセス傾向を分析し、利便性の向上や保守管理に利用し、それ以外の目的のために使用することは
ありません
8.禁止事項について
(1)利用者は、以下に掲げる行為を行ってはならないものとします。
・ 本機能の運用を妨害する行為
・ 短時間における大量のアクセスその他本機能の運用に支障を与える行為
(2)本県は、上記に該当する行為を行っている場合又は該当する行為を行う恐れがあると判断した場合、
利用者に対して、本機能の利用を停止することができるものとします。
9.本規約違反等への対応について
(1)利用者の本規約違反若しくは利用者による第三者の権利侵害に起因又は関連して生じたすべての苦
情や請求については、利用者自身の責任と利用者の費用負担で解決するものとし、本県は一切の責任
を負いません。
(2)利用者の本規約違反若しくは利用者による第三者の権利侵害に起因又は関連して生じたすべての苦
情や請求への対応に関して本県に費用が発生した場合、利用者は当該費用を弁償するものとします。
(3)利用者の本規約違反により本県に損害が生じた場合、利用者は、その損害を賠償する義務がありま
す。
(4)本県は、利用者が本規約等に違反した場合、当該利用者に対し、事前の通告なしに、本機能の利用を
解除することができるものとします。
10.免責事項等について
(1)本県は、本機能の中断又は停止によって生じうるあらゆる損害等に関し、利用者に対し一切の責任を
負いません。
(2)本県は、利用者が本機能を利用して作成するアプリケーション等に関して生じうるあらゆる損害等に関
し、利用者に対し一切の責任を負いません。
11.補償
(1)利用者は、本機能を利用したアプリケーション等の作成、運営並びにアプリケーション及びこれに関する
サービス、コンテンツ等に関連して、第三者との間で生じた苦情、請求その他の紛争等については、自ら
の責任と負担において解決するものとし、本県は利用者及び当該第三者に一切の責任を負いません。
12.準拠法と合意管轄について
(1)本規約は、日本法に基づいて解釈されます。
(2)本規約による本機能の利用又は本規約に関する紛争については、当該紛争に係る本機能又は本規約15本 編
を公開している組織の所在地を管轄する地方裁判所を第一審の専属的な合意管轄裁判所とします。
13.その他
(1)本規約は、著作権法上認められている引用等の利用について、制限するものではありません。
(2)本サイトへのリンクは、原則自由です。ただし、リンク元サイトのコンテンツが法令や公序良俗に反する
もの又は反する恐れがあるものを含むものと認められる場合には、リンクはお断りいたします。リンクの
設定をされる際は、本サイトへのリンクである旨を明示してください(許可や連絡は必要ありません)。
(3)本機能にデータプレビュー機能がありますが、実際の API 処理時間と異なります。表示に時間がかかり
ますので、予めご了承ください。
(4)本規約に違反するような行為等を発見された場合は、長崎県までご連絡ください。
(5)本規約は、2023 年 4 月 1 日に適用します。