API Use Guidelines

1. Overview

These guidelines are required to be followed by developers when developing applications using public transportation-related data ("public transportation data") obtained through the Open Data Challenge for Public Transportation in Tokyo API ("API"). These provide API specification rules, which are not defined in the Open Data Challenge for Public Transportation in Tokyo Permission Rules ("Permission Rules"). Developers must read the Permission Rules and API Specification and follow the rules below.

2. Implementation Rules
2.1. Access Token

Do not publish the access token to third parties. When you publish a sample code to a third party in particular, do not include the access token in the code. (Example: Take appropriate action, such as replacing the token with acl:consumerKey=ACL_CONSUMERKEY.)

2.2. Dynamic Data

Dynamic data, such as train location information, train status information, bus location information, and real-time arrival/departure information, change as time goes by. Displaying old information may mislead or confuse application users. To prevent this, observe the following.

2.2.1. Displaying Time
When you show dynamic data or data generated from dynamic data to users, display the data generation time information (dc:date) obtained through the API on the screen.

2.2.2. Displaying Latest Information
When you show dynamic data or data generated from dynamic data to users, display information as fresh as possible. To help you display the latest information, an API response includes an update interval and valid range. Update data on the screen at a time interval specified in odpt:frequency. Do not use data out of valid range (dct:valid). For dynamic data, do not display out-of-date data, such as data before an update.

2.3. Static Data

Static data, which excludes dynamic data may be updated by traffic operators. Displaying old information may mislead or confuse application users. To prevent this, observe the following.

2.3.1. Displaying Obtained Date and Time
When you show static data or data generated from static data to users, display the obtained date and time on an area of the screen where application users can easily access.

2.3.2. Updating Periodically
When you show static data or data generated from static data to users, update the data periodically by obtaining the latest one through the API. Unless otherwise provided in the specific terms of use, the data must be updated within one week after the Public Transportation Open Data Center notifies you of a data update.

2.4. Notification to your users

Please make sure to notify your users of the following when you make available your application(s) that use the data provided for the Open Data Challenge for Public Transportation in Tokyo.

  1. The source of the data in this app is the Open Data Challenge for Public Transportation in Tokyo.
  2. The accuracy and integrity of the data in this app shall not be guaranteed.
  3. Please provide the email address of the developer for inquiries on the app, so your user(s) will not contact the public transportation operators directly.

E.g.
----
The source of the public transportation data in this app, etc. is the Open Data Challenge for Public Transportation in Tokyo.
They are based on the data provided by the public transportation operators. The accuracy and integrity of the data are not guaranteed. Please do not contact the public transportation operators directly regarding the content of the app.
For inquiries on the app, please contact the following email address.
[E-mail address of the developer]
----

2.5. Using Logo and Railway Line Colors

When you use logo or railway line colors of respective railway lines, do not modify them unless otherwise provided in the specific terms of use.

2.6. Machine Translation

When you provide machine-translated text, state that machine translation was used on an area of the screen where application users can easily access.

3. Support

For any questions, refer to the documents in the Developers Site first. If you are unable to find an appropriate answer, post your question to the forum in the Developers site. The Secretariat Office will answer the posted question wherever possible. Please refrain from making a direct contact with the public transportation operators.

December 7, 2017