Versions Compared

Key

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

...

  • q: informar o endereço ou parte dele;

Parâmetro opcional:

  • type: limita - 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 - Traz os endereços que estiver buscando, usando a lat/long como referência mais próxima.

  • radius - Traz todos os endereços dentro de um raio (valor default: 5.000.000).

Exemplo 1: Sugestões de pedágios a partir de nome parcial

...

https://api.maplink.global/geocode/v1/suggestions?q=CAJAMAR&type=POI

Exemplo de Response, as seguintes informações são retornadas:

...

found: quantidade de registros encontrados.

results: resultados encontrados:

...

poi: ponto de interesse encontrado;

  • name: nome do ponto de interesse.

...

https://api.maplink.global/geocode/v1/suggestions?q=Avenida%20Santos%20Dumont,%2007220000,%20Cumbica%20Guarulhos%20center=-23.46742411032163,-46.53359478248584

https://api.maplink.global/geocode/v1/suggestions?q=Alameda%20Campinas,%2001404100,%20 Jardim%20Paulista%center=-23.5665,-46.65382%radius=10000000

Exemplo de Response, as seguintes informações são retornadas:

  • found: quantidade de registros encontrados.

  • results: resultados encontrados:

    • poi: ponto de interesse encontrado;

      • name: nome do ponto de interesse.

    • address: endereço:

      • road: nome da via;

      • district: bairro;

      • zipCode: CEP;

      • city: cidade;

      • state: estado;

      • mainLocation: coordenadas geográficas em latitude/longitude;

    • type: indica qual o melhor elemento encontrado na base cartográfica para o retorno da coordenada geográfica;

    • score: pontuação de referência do resultado do processo de geocodificação;

    • label: endereço completo encontrado utilizado no processo de geocodificação.

...

languagejson
    • resultado do processo de geocodificação;

    • label: endereço completo encontrado utilizado no processo de geocodificação.

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": 210000,
    "results": [
        {
            "poiaddress": {
                "nameroad": "PedágioAvenida -Santos CaieirasDumont",
            },
            "addressdistrict": {
       "Cumbica",
        "road": "SP 348 - Rod. dos Bandeirantes - Km 36         "zipCode": "07180270",
                "city": "CajamarGuarulhos",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "type": "EXPRESSA",
                "mainLocation": {
                    "lat": -23.3473844208452312325,
                    "lon": -46.813413247474739639
                }
            },
            "type": "POIZIPCODE",
            "score": 188.074078,
            "label": "PedágioAvenida -Santos CaieirasDumont, SP 348 - Rod. dos Bandeirantes - Km 36Cumbica, Cajamar07180270, São PauloGuarulhos, SP"
        },
Code Block
{
    "found": 10000,
 {   "results": [
        "poi": {
   
            "nameaddress": "Pedágio{
- Campo Limpo"             }, "road": "Alameda Campinas",
         "address": {      "district": "Jardim Paulista",
        "road": "SP 348 - Rod. dos Bandeirantes - Km 39"zipCode": "01404100",
                "city": "CajamarSão Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "type": "EXPRESSA",
                "mainLocation": {
                    "lat": -23.32290091225665,
                    "lon": -46.823245715765382
                }
            },
            "type": "POIZIPCODE",
            "score": 184.092031,
            "label": "Pedágio - Campo LimpoAlameda Campinas, SP 348 - Rod. dos Bandeirantes - Km 39, CajamarJardim 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

...