Formato do link de pesquisa

Para links de pesquisa, os parceiros vão fornecer um URL de base específico para pesquisa (consulte Configuração do parceiro). Oferecemos suporte aos seguintes parâmetros de consulta:

Nome do campo Detalhes
from_stop_id

(Repetível) Identificador das paradas em que a viagem pode começar.

Os valores dos stop_ids das estações de partida.

to_stop_id

(Repetível) Identificador das paradas em que a viagem pode terminar.

Os valores dos stop_ids das estações de destino.

search_date

(Data) Dia do serviço da viagem.

Esse campo contém a data com a seguinte string de formato:

YYYYMMDD

lang

(IETF BCP 47, opcional) Campo usado para indicar o idioma selecionado do site de agendamento.

O valor desse campo segue o IETF BCP 47, por exemplo, en-US.

Se o idioma selecionado não estiver disponível ou o campo não for transmitido, o site de agendamento precisará usar um idioma substituto.

cur

(ISO 4217, opcional) Campo usado para indicar a moeda em que os preços devem ser exibidos.

O valor desse campo segue a ISO 4217, por exemplo, USD.

Se a moeda selecionada não puder ser mostrada ou o campo não for transmitido, o site de reserva precisará usar uma moeda alternativa.

utm_source

(String, opcional) Campo usado para indicar o site de nível superior que enviou o tráfego.

Os valores possíveis são google_search e google_maps.

Todos os parâmetros repetíveis são especificados como uma matriz JSON. Para from_stop_id e to_stop_id, vários valores representam várias estações nas localidades de origem e destino.

Exemplos

Neste exemplo, o usuário consulta trens de locality1 para locality2:

  • locality1 mapeia para estações com stop_ids f1 e f2.
  • locality2 mapeia para estações com stop_ids t1 e t2.
  • A data do serviço é 20190716.

Neste exemplo, o URL de base é https://example.com.

Com todas essas informações, use os seguintes valores nos parâmetros:

Nome do campo Detalhes
from_stop_id ["f1", "f2"]
to_stop_id ["t1", "t2"]
search_date 20190716

Confira a seguir o URI final após a codificação:

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

Na página de destino, o usuário poderá ver os itinerários que partem das estações f1 e f2 em 20190716 e chegam a t1 e t2. Todas as combinações de estações são compatíveis:

  • De f1 a t1
  • De f1 a t2
  • De f2 a t1
  • De f2 a t2