Utilisation du Playground​

Le playground de Navitia est un outil interactif permettant de tester et explorer les API Calculateur Ile-de-France Mobilités - Accès générique (v2), Calculateur Ile-de-France Mobilités - Isochrones (coverage idfm) et Calculateur Ile-de-France Mobilités - Messages Info Trafic (coverage idfm).​

Afin d'utiliser le playground intégré sur PRIM, un jeton vous sera demandé.
Vous pouvez utiliser votre jeton API disponible sur PRIM ou le générer en suivant cette documentation.

La page d'accueil

1 : Accédez à plusieurs exemples de requêtes populaires afin de récupérer rapidement certaines informations. ​

2 : Renseignez l'URL PRIM de l'environnement souhaité, cliquez sur GO et commencez à utiliser le Playground préconfiguré pour requêter cette URL​.

3 : Accédez directement à la page du Playground sans aucune pré-configuration​.

4 : Visualisez une réponse à partir d'un fichier JSON au préalablement téléchargé.

La page principale

La page principale du playground permet de configurer les différentes requêtes et visualiser leur réponse.​

1 - Les champs API et Token

• Le champ API décrit l'URL permettant d'utiliser le Playground préconfiguré à partir de cette URL. Il sera toujours https://prim.iledefrance-mobilites.fr/marketplace/v2.
• Le champ Token correspond au jeton que vous avez généré sur la plateforme PRIM.

2 - Le champ Navitia

Le champ Navitia permet d'indiquer l'API Navitia que vous souhaitez requêter.

Par défaut, sans valeur renseignée, cela va appeler l'API Calculateur Ile-de-France Mobilités - Accès générique (coverage idfm).

Pour requêter l'API Calculateur Ile-de-France Mobilités - Messages Info Trafic (coverage idfm), il est nécessaire de renseigner 2 fois le champ line-reports :

• Dans le champ Feature, comme pour le fonctionnement normal
• Dans le champ Navitia

Cela engendre un doublon de la chaîne de caractères line_reports dans l'URL finale, ce qui est souhaité pour le bon fonctionnement de cette API.
Le paramètre count de l'API Calculateur Ile-de-France Mobilités - Messages Info Trafic (coverage idfm) est plafonné à 100 sur PRIM.

Pour requêter l'API Calculateur Ile-de-France Mobilités - Isochrones (coverage idfm), il est également nécessaire de renseigner 2 fois le champ isochrones dans les champs Feature et Navitia.

3 - Le champ Path

Le champ path permet de filtrer la réponse qui sera obtenue via divers filtres tels que le mode de transport utilisé, la ligne de transport ou encore l'arrêt.

Il fonctionne avec un système de clef et de valeur, tous deux ayant une autocomplétion.

Exemple :

Valeurs possibles pour le path physical_modes :

4 - Le champ Feature

Le champ feature permet de spécifier le type de recherche dans le calculateur.
Une autocomplétion est mise en place pour indiquer les différentes features disponibles.

Exemple :

Features disponibles pour l'API Navitia Journeys :

5 - Les champs Parameters

Les champs permettent de spécifier les paramètres de la recherche renseignée via le champ Feature.
Ils fonctionnent avec un système de clef et de valeur, tous deux ayant une autocomplétion.

6 - Récapitulatif de l'URL finale

Au clic sur le bouton Submit, l'URL paramétrée est appelée.

Elle s'actualise automatiquement en fonction des paramètres sélectionnés dans les champs précédents.

Pour garantir un bon fonctionnement de l'outil, le format de l'URL devra toujours respecter le format suivant :

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

7 - Visualisation de la réponse

Une fois la requête effectuée, la réponse est formatée pour être visualisée dans cette section.
Il est possible de déplier chaque partie correspondant à des sous-sections du JSON original et les visualiser sous plusieurs formes ( JSON, cartes etc. ).