| Table of Contents |
|---|
Construindo requisições para a Suggestions API
O objetivo desse terceiro endpoint, Suggestions, é retornar as coordenadas geográficas a partir de um endereço fornecido na própria URL.
Para realizar utilizar a requisição para a Suggestions é API será necessário enviar a requisição usando o método GET para o seguinte endpoint:
Na própria URL serão enviados todos os parâmetros para obter a coordenada geográfica as coordenadas geográficas e sugestões de endereços.
Parâmetros da requisição
Parâmetro obrigatório
q- Informar o endereço ou parte dele.
Parâmetros opcionais
type- Limita o tipo da pesquisa. Valores possíveis:ZIPCODE - CEP;STATE- Estado;CITY- Cidade;POI- Pedágios (Até a data deste documento 10/02/2023atual);DISTRICT- Bairro.
center- Coordenadas de referência para a busca de resultados. Formato:center=-23.552088765,-46.6341653162;radius- Especifica o raio de buscarbusca, em metros, a partir do ponto central. Caso não seja informado, o valor padrão é 5.000.000 metros (5.000 Km).
Exemplo 1 - Sugestões de pedágios a partir de nome parcial
No exemplo abaixo, vamos buscar por pontos de interesse (POI) que contenham a palavra “CAJAMAR”. A requisição encontra-se abaixo:
...
| Info |
|---|
Nota: Quanto maior o score, maior será a relevância do resultado para o endereço solicitado. |
Exemplo 2 - Busca de sugestões a partir de texto livre
Nesse exemplo, queremos obter sugestões para o texto “Alameda Campinas, 01404100, Jardim Paulista”. A requisição encontra-se abaixo:
| Info |
|---|
Nota: Ao utilizar o texto livre para busca de sugestões em que nenhum |
Exemplo da ResponseA resposta completa pode ser conferida abaixo:
| Code Block | ||
|---|---|---|
| ||
{
"found": 11,
"results": [
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404100",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5665,
"lon": -46.65382
}
},
"type": "ZIPCODE",
"score": 37.228725,
"label": "Alameda Campinas, Jardim Paulista, 01404100, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "12947480",
"city": "Atibaia",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.1410185925,
"lon": -46.5576962537
}
},
"type": "ZIPCODE",
"score": 25.78013,
"label": "Alameda Campinas, Jardim Paulista, 12947480, Atibaia, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404002",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.57156,
"lon": -46.65871
}
},
"type": "ZIPCODE",
"score": 25.732224,
"label": "Alameda Campinas, Jardim Paulista, 01404002, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404200",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5674342,
"lon": -46.65478485
}
},
"type": "ZIPCODE",
"score": 25.732224,
"label": "Alameda Campinas, Jardim Paulista, 01404200, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404000",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5665,
"lon": -46.65382
}
},
"type": "ZIPCODE",
"score": 25.13713,
"label": "Alameda Campinas, Jardim Paulista, 01404000, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404001",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.56767,
"lon": -46.65498
}
},
"type": "ZIPCODE",
"score": 24.93925,
"label": "Alameda Campinas, Jardim Paulista, 01404001, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404003",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5727386,
"lon": -46.65995255
}
},
"type": "ZIPCODE",
"score": 24.93925,
"label": "Alameda Campinas, Jardim Paulista, 01404003, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas 150",
"district": "Jardim Paulista",
"zipCode": "01404900",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5658,
"lon": -46.65323
}
},
"type": "ZIPCODE",
"score": 24.005688,
"label": "Alameda Campinas 150, Jardim Paulista, 01404900, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas 433",
"district": "Jardim Paulista",
"zipCode": "01404901",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5658,
"lon": -46.65323
}
},
"type": "ZIPCODE",
"score": 24.005688,
"label": "Alameda Campinas 433, Jardim Paulista, 01404901, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas 463",
"district": "Jardim Paulista",
"zipCode": "01404902",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5658,
"lon": -46.65323
}
},
"type": "ZIPCODE",
"score": 23.845266,
"label": "Alameda Campinas 463, Jardim Paulista, 01404902, São Paulo, São Paulo, SP"
}
]
} |
Exemplo 3 - Busca de endereço definindo um raio de busca
Nesse exemplo vamos usar o mesmo endereço do exemplo anterior, “Alameda Campinas, 01404100, Jardim Paulista”, mas dessa vez vamos definir um ponto central e um raio de busca para melhorar a precisão dos resultados.
...