Format du lien de recherche

Pour les liens de recherche, les partenaires fourniront une URL de base spécifique à la recherche (voir Configuration des partenaires). Nous acceptons les paramètres de requête suivants :

Nom du champ Détails
from_stop_id

(Reproductible) Identifiant des arrêts auxquels le trajet peut commencer.

Valeurs des stop_id des gares de départ.

to_stop_id

(Reproductible) Identifiant des arrêts auxquels le trajet peut se terminer.

Valeurs des stop_id des gares de destination.

search_date

(Date) Jour de service du trajet.

Ce champ contient la date au format suivant :

YYYYMMDD

lang

(IETF BCP 47, facultatif) Champ utilisé pour indiquer la langue sélectionnée du site de réservation.

La valeur de ce champ est conforme à la norme IETF BCP 47, par exemple en-US.

Si la langue sélectionnée n'est pas disponible ou si le champ n'est pas transmis, le site de réservation doit utiliser une langue de remplacement.

cur

(ISO 4217, facultatif) Champ utilisé pour indiquer la devise dans laquelle les prix doivent être affichés.

La valeur de ce champ est conforme à la norme ISO 4217 (par exemple, USD).

Si la devise sélectionnée ne peut pas être affichée ou si le champ n'est pas transmis, le site de réservation doit utiliser une devise de remplacement.

utm_source

(Chaîne, facultatif) Champ utilisé pour indiquer le site de premier niveau qui a envoyé le trafic.

Les valeurs possibles sont google_search et google_maps.

Tous les paramètres répétables sont spécifiés sous forme de tableau JSON. Pour from_stop_id et to_stop_id, plusieurs valeurs représentent plusieurs gares dans les localités d'origine et de destination.

Exemples

Dans cet exemple, l'utilisateur recherche des trains de locality1 à locality2 :

  • locality1 correspond aux stations avec les stop_id f1 et f2.
  • locality2 correspond aux stations avec les stop_id t1 et t2.
  • La date du service est le 20190716.

Dans cet exemple, l'URL de base est https://example.com.

Compte tenu de toutes ces informations, utilisez les valeurs suivantes pour les paramètres :

Nom du champ Détails
from_stop_id ["f1", "f2"]
to_stop_id ["t1", "t2"]
service_date 20190716

Voici l'URI final après encodage :

https://example.com?from_stop_id=%5B%22f1%22,%22f2%22%5D&to_stop_id=%5B%22t1%22,%22t2%22%5D&search_date=20190716

Sur la page de destination, l'utilisateur pourra consulter les itinéraires au départ des gares f1 et f2 le 20190716 et à destination de t1 et t2. Toutes les combinaisons de stations sont acceptées :

  • Du f1 au t1
  • Du f1 au t2
  • Du f2 au t1
  • Du f2 au t2