公共交通データAPI開発者用ガイドライン(運用フェーズ1用)


1. 概要

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

なお本ガイドラインは、公共交通オープンデータセンターの運用フェーズ1(主として静的データの公共交通オープンデータ協議会の会員向け提供)への適用を想定しています。


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. ロゴ画像と路線ラインカラーの利用について

鉄道路線に含まれるロゴ画像および路線ラインカラーを利用する際は、そのまま加工せずに利用してください。


2.5. 機械翻訳について

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


3. サポート

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


2016年10月14日


以上