Using the Playground

The Navitia playground is an interactive tool for testing and exploring the APIs Calculator Ile-de-France Mobilités - Generic access (v2), Calculator Ile-de-France Mobilités - Isochrones (coverage idfm) and Calculator Ile-de-France Mobilités - Traffic Info Messages (coverage idfm).

In order to use the built-in playground on PRIM, you will be asked for a token.
You can use your API token available on PRIM or generate it by following this documentation.

The Home Page

1: Access several popular sample queries to quickly retrieve certain information.

2: Fill in the PRIM URL of the desired environment, click GO , and start using the preconfigured Playground to query that URL.

3: Go directly to the Playground page without any pre-configuration.

4: View an answer from a previously downloaded JSON file.

The main page

The main page of the playground allows you to configure the different requests and view their response.

1 - The API and Token fields

• The API field describes the URL to use the preconfigured Playground from that URL. It will always be https://prim.iledefrance-mobilites.fr/marketplace/v2.
• The Token field corresponds to the token you generated on the PRIM platform.

2 - The Navitia Field

The Navitia field is used to specify the Navitia API you want to query.

By default, without a value entered, this will call the Ile-de-France Mobilités Calculator API - Generic access (idfm coverage).

To request the API Calculator Ile-de-France Mobilités - Messages Info Trafic (coverage idfm), it is necessary to fill in the line-reports field 2 times:

• In the Feature field, as with normal operation
• In the Navitia field

This results in a duplicate of the string line_reports in the final URL, which is desired for the proper functioning of this API.
The count parameter of the API Calculator Ile-de-France Mobilités - Messages Info Trafic (idfm coverage) is capped at 100 on PRIM.

To query the Ile-de-France Mobilités - Isochrones Calculator API (idfm coverage), it is also necessary to fill in the isochrones field 2 times in the Feature and Navitia fields.

3 - The Path field

The path field allows you to filter the answer that will be obtained via various filters such as the mode of transport used, the transport line or the stop.

It works with a system of key and value, both of which have an autocomplete.

Example:

Possible values for path physical_modes:

4 - The Feature field

The feature field allows you to specify the type of search in the calculator.
An autocomplete is set up to indicate the different features available.

Example :

Features available for the Navitia Journeys API:

5 - Parameters fields

The fields allow you to specify the parameters of the search filled in via the Feature field.
They work with a key and value system, both of which have autocomplete.

6 - Final URL Summary

When the Submit button is clicked, the parameterized URL is called.

It updates automatically based on the settings selected in the previous fields.

To ensure that the tool works properly, the URL format should always follow the following format:

https://prim.iledefrance-mobilites.fr/marketplace/v2/navitia/${API_NAVITIA}/${PATH}/${FEATURE}?${QUERY_PARAMS}

7 - Visualization of the answer

Once the request is made, the response is formatted to be viewed in this section.
It is possible to unfold each part corresponding to subsections of the original JSON and view them in several forms (JSON, maps etc.).