公共交通データAPI開発者用ガイドライン

公共交通データAPI開発者用ガイドライン

1. 概要

このドキュメントは、公共交通データAPI(以下、本API)によって取得した、公共交通に関連するデータ(以下、本公共交通データ)を利活用したアプリケーションを開発する際に、開発者が守る必要のあるガイドラインです。公共交通オープンデータセンター利用規約(以下、本センター利用規約)が規定していない、主に技術的な内容に関する規定を記しています。開発者は、本センター利用規約ならびにAPI仕様書をお読みの上、以下の規定を遵守してください。

2. 実装時のルール

2.1. アクセストークンについて

第三者にアクセストークンを開示しないでください。特に、サンプルコードなどを第三者に開示する場合に、アクセストークンを含めないようご注意ください。
(例:acl:consumerKey=ACL_CONSUMERKEYと置き換えるなどの工夫をお願いします。)

2.2. 動的データについて

列車ロケーション情報、列車運行情報、バスロケーション情報やリアルタイム発着情報などの動的データは、時間とともに変化します。古い情報の提示は、アプリケーション利用者の誤解や混乱を招く可能性があります。このことを防ぐために、以下を遵守して下さい。

2.2.1. 時刻の表示

動的データまたは動的データから生成されたデータをアプリケーション利用者に表示する場合は、本APIから得られるデータ生成時刻情報(dc:date)を、画面上に表示してください。

2.2.2. 最新情報の表示

動的データまたは動的データから生成されたデータをアプリケーション利用者に表示する場合は、可能な限り、最新の情報を表示してください。最新情報の表示を支援するために、本APIのレスポンスには更新間隔や有効範囲が含まれています。画面に表示するデータは、odpt:frequencyで指定される時間間隔で更新してください。また、有効範囲(dct:valid)を超えたデータを使用しないでください。また動的データの表示に際しては、更新前のデータなど、既に最新ではなくなった情報の表示は行わないでください。

2.3. 静的データについて

静的データ(動的データ以外のデータ)も、交通事業者により更新されることがあります。古い情報の提示は、アプリケーション利用者の誤解や混乱を招く可能性があります。このことを防ぐために、以下を遵守して下さい。

2.3.1. 取得日時の表示

静的データまたは静的データから生成されたデータをアプリケーション利用者に表示する場合は、取得日時を、アプリケーション利用者が容易にアクセスできる画面上に表示してください。

2.3.2. 定期的な更新

静的データまたは静的データから生成されたデータをアプリケーション利用者に表示する場合は、本APIを利用して定期的に最新データを取得し、更新を行ってください。特定利用条件などで特段の定めがない限り、公共交通オープンデータセンターがデータ更新の通知を行ってから、1週間以内にデータ更新を行うようにしてください。

2.4. アプリケーション利用者への通知について

本公共交通データを利用したアプリケーションを公開する際には、以下の点を必ずアプリケーション利用者に通知してください。

1.  本公共交通データが公共交通オープンデータセンターにおいて提供されるデータであることを表示してください。
2.  本公共交通データが正確性、完全性が保証されたものではないことを表示してください。
3.  アプリケーションに関する問い合わせ先として開発者のメールアドレスなどを明記し、アプリケーション利用者が公共交通事業者への直接の問合せを行わないようにしてください。

例)
----
本アプリケーション等が利用する公共交通データは、公共交通オープンデータセンターにおいて提供されるものです。
公共交通事業者により提供されたデータを元にしていますが、必ずしも正確・完全なものとは限りません。本アプリケーションの表示内容について、公共交通事業者への直接の問合せは行わないでください。
本アプリケーションに関するお問い合わせは、以下のメールアドレスにお願いします。
[開発者のメールアドレス]
----

2.5. ロゴ画像と路線ラインカラーの利用について

ロゴ画像および路線ラインカラーを利用する際は、特定利用条件などで特段の定めがない限り、そのまま加工せずに利用してください。

2.6. 機械翻訳について

機械翻訳を行った結果のデータを提供する場合には、アプリケーション利用者が容易にアクセスできる画面上に、機械翻訳を利用している旨を明示してください。

3. サポート

質問がある場合は、まず開発者サイトのドキュメントを参照してください。質問の答えが見つからない場合は、事務局宛に質問内容をメールで送信して下さい。送信された質問は、事務局が可能な範囲内でご回答します。

2019年5月31日

以上