v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB

Lugares

Busca por Localização Geográfica

Serviço que retorna locais encontrados por localização geográfica. Utiliza latitude e longitude ou informações de cidade/estado para encontrar terminais e destinos próximos, facilitando a busca por localização atual do usuário.

get/partners/api/v4/places/by-location

Query parameters

namestring

Example:Sao Paulo

Nome do local pesquisado

cityNamestring

Example:São Paulo

Nome de exibição da cidade do local

statestring

Example:SP

Nome de exibição do estado do local

latitudestring

Example:-43.209162

Para obter geolocalização sobre o local

longitudestring

Example:-22.899217

Para obter geolocalização sobre o local

radiusnumber

Example:2

Informação usada com a geolocalização para fazer uma forma

limitnumber

Example:20

Limitar número de locais na lista de resultados

fieldsstring

Example:id,name,slug,terminal,city,state,country,latitude,longitude,weight,latlon,radius,useGroupByCity

Filtrar campos para retornar na resposta. Separados por vírgula

Headers

cloudfront-viewer-citystring required

Nome da cidade no cabeçalho (pode ser vazio se a localização não estiver disponível)

cloudfront-viewer-country-regionstring required

Nome do estado no cabeçalho (pode ser vazio se a localização não estiver disponível)

cloudfront-viewer-latitudestring required

Latitude no cabeçalho (pode ser vazio se a localização não estiver disponível)

cloudfront-viewer-longitudestring required

Longitude no cabeçalho (pode ser vazio se a localização não estiver disponível)

Response

Sucesso. Lista de locais encontrados por localização.

idnumber required

Identificador unico do local

namestring required

Nome de exibição do local

slugstring required

Um identificador apresentável, geralmente usado em URLs ou caminhos, como uma sigla

latitudestring required

Latitude do local para geolocalização

longitudestring required

Longitude do local para geolocalização

weightnumber required

Peso do local para ordenação

radiusnumber required

Informação de raio do local em metros

useGroupByCityboolean required

Se o local usa agrupamento por cidade

boardingPassboolean required

Se o local permite cartão de embarque eletronico

Example response

[
  {
    "id": 1234,
    "name": "Rio de Janeiro, RJ - Rodov. do Rio",
    "slug": "rio-de-janeiro-rj",
    "terminal": {
      "id": 1234,
      "name": "Terminal Rodoviário do Rio",
      "slug": "terminal-rodoviario-do-rio"
    },
    "city": {
      "id": 1234,
      "name": "Rio de Janeiro",
      "slug": "rio-de-janeiro"
    },
    "state": {
      "id": 1234,
      "name": "Rio de Janeiro",
      "slug": "rio-de-janeiro",
      "code": "RJ"
    },
    "country": {
      "id": 1234,
      "name": "Brasil",
      "slug": "brasil",
      "code": "BR"
    },
    "latitude": "-22.899217",
    "longitude": "-43.209162",
    "weight": 175059,
    "latlon": {
      "lat": "-22.899217",
      "lon": "-43.209162"
    },
    "radius": 2,
    "useGroupByCity": true,
    "boardingPass": true
  }
]