Geocode Autocomplete – Maplink Documentação APIs

A API de Geocode Autocomplete tem a função de:

retornar os dados geográficos quando pesquisado um endereço, ou parte dele;
retornar endereço de um POI;
permitir a pesquisa por CEP, retornando o endereço e seus dados geográficos;

Endpoint Geocode: https://api.maplink.global/geocode/v1/geocode
Endpoint Reverse Geocode: https://api.maplink.global/geocode/v1/reverse

Simulação

Vamos simular a obtenção do Geocode:

Dados de entrada Geocode

O endpoint do Geocode deve ser enviado via POST, os parâmetros serão enviados via BODY.

Parâmetro
road	o usuário irá informar o nome da rua ou parte dele;
number	o usuário irá informar o número do logradouro, NÃO os dados do complemento;
city	o usuário irá informar o nome da cidade;
state	o usuário irá informar o nome do estado;
district	o usuário irá informar o nome do bairro;
zipcode	o usuário irá informar o CEP para busca;

Exemplo de request API Geocode

Request API Geocode

{
    "road": "Alameda Jauaperi",
    "number": 976,
    "city": "São Paulo",
    "state": "SP",
    "district": "Moema",
    "zipcode": "04523014" 
}

Exemplo de response API Geocode

Response API Geocode

{
    "found": 7,
    "results": [
        {
            "address": {
                "road": "Alameda Jauaperi",
                "number": "976",
                "district": "Moema",
                "zipCode": "04523015",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
"mainLocation": {
                    "lat": -23.605654977400636,
                    "lon": -46.66789209049858
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, 976, Moema, 04523015, São Paulo, São Paulo, SP"
        },
        {
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523014",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.60515,
                    "lon": -46.667365
                }
            },
            "type": "ZIPCODE",
            "score": 53.61926,
            "label": "Alameda Jauaperi, Moema, 04523014, São Paulo, São Paulo, SP"
        },
        {
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523012",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.59839,
                    "lon": -46.66102
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, Moema, 04523012, São Paulo, São Paulo, SP"
        },
{
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523016",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.610065,
                    "lon": -46.67198
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, Moema, 04523016, São Paulo, São Paulo, SP"
        },
        {
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523013",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.604365,
                    "lon": -46.66663
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, Moema, 04523013, São Paulo, São Paulo, SP"
        },
        {
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523011",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.601985,
                    "lon": -46.66441
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, Moema, 04523011, São Paulo, São Paulo, SP"
        },
        {
            "address": {
                "road": "Alameda Jauaperi",
                "district": "Moema",
                "zipCode": "04523010",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.598645,
                    "lon": -46.66124
                }
            },
            "type": "ZIPCODE",
            "score": 51.887398,
            "label": "Alameda Jauaperi, Moema, 04523010, São Paulo, São Paulo, SP"
        }
    ]
}

Dados de entrada Autocomplete

O endpoint do Autocomplete deve ser enviado via GET, os parâmetros serão enviados via REQUEST. Ex: https://api.maplink.global/geocode/v1/suggestions?q=CAJAMAR, SAOPAULO&type=POI

Parâmetro
q	o usuário irá informar o endereço ou parte dele;
type	o usuário irá informar o tipo da pesquisa	ZIPCODE \| STATE \| CITY \| POI \| DISTRICT

Exemplo de request API Autocomplete

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

Exemplo de response API Autocomplete

Response API Autocomplete

{
    "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": 28.12994,
            "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": 27.729694,
            "label": "Pedágio - Campo Limpo, SP 348 - Rod. dos Bandeirantes - Km 39, Cajamar, São Paulo, SP"
        }
    ]
}

Dados de entrada Reverse Geocode

O endpoint do Reverse Geocode deve ser enviado via POST, os parâmetros serão enviados via BODY:

Parâmetro
ID	o usuário irá informar o ID da estrutura de coordenadas, parâmetro opcional, para o cliente ter a identificação de qual é o envio e a resposta da coordenada consultada;
lat	o usuário irá informar a latitude da coordenada;
lon	o usuário irá informar a longitude da coordenada;
distance	o usuário irá informar a distância máxima, em metros, que a busca será feita à partir do ponto, é opcional, o default é 1000 metros;

Exemplo de request API Autocomplete

Request API Autocomplete

[
    {
        "id": "L1",
        "lat": -26.90314282963394,
        "lon": -48.68018153051618,
        "distance": 500
    },
    {
        "id": "L2",
        "lat": -26.908620508271895,
        "lon": -48.67848497677373
    }
]

Exemplo de response API Reverse Geocode

Response API Reverse Geocode

{
    "found": 2,
    "results": [
        {
            "id": "L1",
            "address": {
                "road": "Rua Leopoldo Hess",
                "district": "São João",
                "zipCode": "88304260",
                "city": "Itajaí",
                "state": {
                    "code": "SC",
                    "name": "Santa Catarina"
                },
                "mainLocation": {
                    "lat": -26.903096066879815,
                    "lon": -48.68019337952067
                },
                "geometry": [
                    {
                        "lat": -26.90371956910269,
                        "lon": -48.6800353812277
                    },
                    {
                        "lat": -26.902472564656932,
                        "lon": -48.68035137781362
                    }
                ],
                "leftZipCode": "88304260",
                "rightZipCode": "88304260",
                "leftFirstNumber": 2,
                "leftLastNumber": 244,
                "rightFirstNumber": 1,
                "rightLastNumber": 161
            },
            "type": "ROAD",
            "distance": 5.329992775797795,
            "label": "Rua Leopoldo Hess, São João, 88304260, Itajaí, Santa Catarina, SC"
        },
        {
            "id": "L2",
            "address": {
                "road": "Avenida Gov. Adolfo Konder",
                "district": "Cidade Nova",
                "zipCode": "88308001",
                "city": "Itajaí",
                "state": {
                    "code": "SC",
                    "name": "Santa Catarina"
                },
                "mainLocation": {
                    "lat": -26.908718086919976,
                    "lon": -48.67877389320043
                },
                "geometry": [
                    {
                        "lat": -26.908539588131305,
                        "lon": -48.67824538861362
                    },
                    {
                        "lat": -26.908896585708646,
                        "lon": -48.67930239778724
                    }
                ],
                "leftZipCode": "88308001",
                "rightZipCode": "88308000",
                "leftFirstNumber": 231,
                "leftLastNumber": 531,
                "rightFirstNumber": 232,
                "rightLastNumber": 532
            },
            "type": "ROAD",
            "distance": 30.641980035785615,
            "label": "Avenida Gov. Adolfo Konder, Cidade Nova, 88308001, Itajaí, Santa Catarina, SC"
        }
    ]
}