Using the Playground

The playground of Navitia is an interactive tool allowing to test and explore the APIs Calculator Ile-de-France Mobilités - Generic Access (v2), Calculator Ile-de-France Mobilités - Isochrones (idfm coverage) and Calculator Ile-de-France Mobilités - Trafic messages (idfm coverage).

In order to use the playground integrated 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 this URL.

3: Access the Playground page directly without any preconfiguration.

4: View a response from a previously downloaded JSON file.

The main page

The main Playground page lets you configure the various requests and view their response.

1 - The API and Token fields

• The API field describes the URL allowing the preconfigured Playground to be used from this 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 indicate the Navitia API you wish to request.

By default, without a value filled in, this will call the API Calculator Ile-de-France Mobilités - Accès générique (coverage idfm).

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

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

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

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

3 - The Path field

The path field is used to filter the response, which will be obtained via various filters such as the mode of transport used, the transport line or the Stops.

It works with a system of keys and values, both of which are autocomplete.

Possible values for the path physical_modes:

4 - The Feature field

The feature field is used 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 entered via the Feature field.
They work with a key and value system, both of which are autocomplete.

6 - Final URL summary

On clicking the Submit button, the parameterized URL is called up.

It is automatically updated according to the parameters selected in the previous fields.

To ensure that the tool functions correctly, the URL format must always respect the following format:

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

7 - Viewing the response

Once the request has been made, the response is formatted for viewing 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.).