Versions Compared

Version Old Version 5 New Version 6
Changes made by

Willian Silva

Willian Silva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Body e Parâmetros da Request

Parâmetro obrigatório

...

  • q: informar - 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 13/04/2021);

    • DISTRICT: Bairro.

  • center - Coordenadas de referência para a busca de resultados. Formato: center=-23.552088765,-46.6341653162

  • radius - Especifica o raio de buscar, 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

Exemplo de Request com parâmetros obrigatórios:

...

Code Block
languagejson
{
    "found": 2,
    "results": [
        {
            "poi": {
                "name": "Pedágio - Caieiras"
            },
            "address": {
                "road": "SP 348 - Rod. dos Bandeirantes - Km 36",
                "city": "Cajamar",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "type": "EXPRESSA",
                "mainLocation": {
                    "lat": -23.3473844208,
                    "lon": -46.813413247
                }
            },
            "type": "POI",
            "score": 1.0,
            "label": "Pedágio - Caieiras, SP 348 - Rod. dos Bandeirantes - Km 36, Cajamar, São Paulo, SP"
        },
        {
            "poi": {
                "name": "Pedágio - Campo Limpo"
            },
            "address": {
                "road": "SP 348 - Rod. dos Bandeirantes - Km 39",
                "city": "Cajamar",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "type": "EXPRESSA",
                "mainLocation": {
                    "lat": -23.3229009122,
                    "lon": -46.8232457157
                }
            },
            "type": "POI",
            "score": 1.0,
            "label": "Pedágio - Campo Limpo, SP 348 - Rod. dos Bandeirantes - Km 39, Cajamar, São Paulo, SP"
        }
    ]
}
Code Block
{
    "found": 10000,
    "results": [
        {
            "address": {
                "road": "Avenida Santos Dumont",
                "district": "Cumbica",
                "zipCode": "07180270",
                "city": "Guarulhos",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.452312325,
                    "lon": -46.474739639
                }
            },
            "type": "ZIPCODE",
            "score": 88.74078,
            "label": "Avenida Santos Dumont, Cumbica, 07180270, Guarulhos, SP"
        },
Code Block
{
    "found": 10000,
    "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": 84.92031,
            "label": "Alameda Campinas, Jardim Paulista, 01404100, São Paulo, SP"
        },
Info

Nota: Verifique o score para verificar a pontuação alcançada a partir dos elementos usados nos parâmetros. Por exemplo, se a request possui todos os elementos de endereço preenchidos e os mesmos foram encontrados na base cartográfica, se espera uma pontuação maior. Se a request possuir somente CEP, a pontuação será menor.

Para informações detalhadas de como funciona o score do elasticsearch, consulte o link:

how-scoring-works-in-elasticsearch

Exemplo 2

...

- Busca de sugestões a partir de texto livre

Exemplo de Request para obter sugestões para o texto “Alameda Campinas, 01404100, Jardim Paulista”:

...