Se você está nessa página, nós assumimos que:
Você já possui uma chave de acesso;

Tenha conhecimento sobre o funcionamento dos exemplos de código através do guia Primeiros passos;

Tenha conhecimento de XML e Web Services SOAP.

O serviço MapRender disponibiliza através de suas operações as funcionalidades de renderização de mapas através de contextos diversos, considerando a geração por uma área específica em coordenadas geográficas, por pontos, cidade ou estado, além de prover as opções de ampliação e deslocamento da área.

Parâmetro de entrada “routeId”

As operações deste serviço possuem o parâmetro “routeId” como opcional. Através dele é possível fornecer o identificador de uma rota gerada através das operações do serviço Route, possibilitando a identificação da rota no mapa gerado. Este identificador é válido pelo período de três horas, sendo invalidado após este intervalo. Os exemplos em código fonte para as operações descritos ao decorrer desta seção utiliza em alguns casos um identificador de rota de exemplo. Caso o exemplo seja executado, fornecendo o mesmo identificador de rota, será retornado um endereço de acesso inválido para a imagem do mapa, indicando que a operação sofreu falha no seu processamento.

Dados de retorno

Existe um retorno padrão para as operações disponíveis, onde é disponibilizando o endereço para acesso da imagem com o mapa renderizado gerado e um objeto “Extent“, sendo este referente as dimensões do mapa, com os pontos mínimos e máximos para as coordenadas X e Y.

A estrutura abaixo contém as informações de versão, endereço de acesso e contrato de operação para o serviço MapRender.

Nome do serviço: MapRender
Endereço de acesso: http://services.maplink.com.br/webservices/v3/MapRender/MapRender.asmx
Versão atual: V3.0
Funcionalidade Nome da Operação
Renderização de mapa por área GetMap
Renderização de mapa com navegação por deslocamento GetPan
Renderização de mapa com ampliação GetZoom
Renderização de mapa por cidade GetZoomCity
Renderização de mapa com área máxima GetZoomFullExtent
Renderização de mapa por coordenadas e raio GetZoomRadius
Renderização de mapa por estado GetZoomState
Renderização de mapa com ampliação por pontos GetZoomWindow

A funcionalidade de renderização de mapas por área está disponível através da operação “GetMap” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado, considerando a área solicitada através dos parâmetros X e Y (valores mínimo e máximo) e as dimensões fornecidas como entrada para a operação.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, “extent” (Extent), mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • extent

Armazena uma implementação da estrutura Extent com as dimensões de uma área no mapa através dos valores mínimos e máximos para as coordenadas X e Y.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “Extent” representa a área do mapa através dos valores mínimos e máximos para as coordenadas X e Y
Nome do Atributo Tipo Descrição
XMin Número com casas decimais Indica o valor mínimo da coordenada X
XMax Número com casas decimais Indica o valor máximo da coordenada Y
YMin Número com casas decimais Indica o valor mínimo da coordenada X
YMax Número com casas decimais Indica o valor máximo da coordenada Y
Estrutura “MapOptions” contém as propriedades e filtros para geração de um mapa
Nome do Atributo Tipo Descrição
mapSize Estrutura MapSize Indica as propriedades de dimensão para um mapa
scaleBar Booleano Disponibiliza opção para exibição de barra de escala em um mapa
Estrutura “MapSize” contém as propriedades de dimensão de um mapa
Nome do Atributo Tipo Descrição
height Número inteiro Indica a altura do mapa
width Número inteiro Indica a largura do mapa

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetMap”, com o objetivo de obter um mapa renderizado para uma determinada área. A área desejada é representada através da estrutura “Extent” e possui os valores mínimos “-46.65218″ para X e “-23.56501″ para Y, e máximos “-46.61399″ para X e “-23.52279″ para Y. Adicionalmente, o parâmetro “routeId” é preenchido com o valor do identificador obtido para uma rota previamente gerada em uma das operações do serviço Route.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas com navegação por área de deslocamento está disponível através da operação “GetPan” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado para as dimensões fornecidas como entrada para a operação, considerando uma direção (norte, nordeste, leste, sudeste, sul, sudoeste, oeste e noroeste) e um nível de deslocamento.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, direction”, “percNavegation”, extent” (Extent), mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • direction

Armazena um número com casas decimais com uma implementação da estrutura direction as direções de deslocamento disponíveis.

  • percNavegation

Armazena com um número inteiro com o nível de deslocamento para a direção selecionado.

  • extent

Armazena uma implementação da estrutura Extent com as dimensões do mapa através dos valores mínimos e máximos para as coordenadas X e Y.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “Direction” representa as direções disponíveis para realizar a operação de deslocamento em um mapa gerado.
Atributo Descrição
1 Norte
2 Nordeste
3 Leste
4 Sudeste
5 Sul
6 Sudoeste
7 Oeste
8 Noroeste

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetPan”, com o objetivo de obter um mapa renderizado para uma determinada área, considerando uma direção e nível de deslocamento. A área desejada é representada através da estrutura “Extent” e possui os valores mínimos “-46.65218″ para X e “-23.56501″ para Y, e máximos “-46.61399″ para X e “-23.52279″ para Y, juntamente com o valor “3″ para “percNavegation”, representando direção ao leste e “5″ para o parâmetro “direction”. Adicionalmente, o parâmetro “routeId” é preenchido com o valor do identificador obtido para uma rota previamente gerada em uma das operações do serviço Route.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas com ampliação está disponível através da operação “GetZoom” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado para as dimensões fornecidas como entrada para a operação, considerando um valor de percentual de ampliação (“zoom”) do mapa.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, “extent” (Extent), mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • extent

Armazena uma implementação da estrutura Extent com as dimensões do mapa através dos valores mínimos e máximos para as coordenadas X e Y.

  • percZoom

Armazena um número inteiro com o valor de percentual de ampliação do mapa.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoom”, com o objetivo de obter um mapa renderizado para uma determinada área com um nível de ampliação. A área desejada é representada através da estrutura “Extent” e possui os valores mínimos “-46.65218″ para X e “-23.56501″ para Y, e máximos “-46.61399″ para X e “-23.52279″ para Y, juntamente com o valor “-0.6″ para o parâmetro “percZoom”, representando o nível de amplitude para o mapa.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas por cidade com ampliação está disponível através da operação “GetZoomCity” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado para uma determinada cidade.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, mo (MapOptions), “city” (City) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • city

Armazena uma implementação da estrutura City com os dados da cidade e seu estado.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “City” contém os dados do nome da cidade e de seu estado.
Nome do Atributo Tipo Descrição
name Conjunto de caracteres Indica o nome da cidade
state Conjunto de caracteres Indica o nome do estado

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoomCity”, com o objetivo de obter um mapa renderizado com a área total de uma cidade a ser determinada como parâmetro. Os dados fornecidos como entrada para a estrutura “city” (City) foram a cidade “São Paulo” e estado “SP”, juntamente com as opções do mapa a ser criado através da estrutura “mapOptions”.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas com área máxima está disponível através da operação “GetZoomFullExtent” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado, onde é exibido toda a área coberta disponível.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoomFullExtent”, com o objetivo de obter um mapa renderizado com a área total disponível. O dado fornecido como entrada foi a parametrização do mapa com as suas dimensões de altura e largura, através da estrutura “mapOptions”.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir é apresentada a imagem obtida com um mapa renderizado seguindo o exemplo descrito anteriormente.

A funcionalidade de renderização de mapas por coordenadas e raio está disponível através da operação “GetZoomRadius” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado, considerando coordenadas geográficas e um raio para a localização do ponto do mapa desejado.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, point (Point), radius, mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • point

Armazena uma implementação da estrutura Point com as coordenadas geográficas correspondente a localização desejada.

  • radius

Armazena um número inteiro com o valor do raio a ser considerado para localização do endereço.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Estrutura “Point” contém as coordenadas de latitude e longitude para um determinado endereço
Nome do Atributo Tipo Descrição
X Número com casas decimais Indica a longitude de uma coordenada geográfica
Y Número com casas decimais Indica a latitude de uma coordenada geográfica

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoomRadius”, com o objetivo de obter um mapa renderizado a partir de uma coordenada geográfica e raio informados. Os dados fornecidos como entrada foram o ponto com longitude “-46.6867705″ e latitude “-23.5924345″, e raio com valor “500″.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas por estado com ampliação está disponível através da operação “GetZoomState” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado para um determinado estado.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, mo (MapOptions), “state” e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • state

Armazena um conjunto de caracteres com o nome do estado.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoomState”, com o objetivo de obter um mapa renderizado com a área total de um estado a ser determinado como parâmetro. O nome do estado é fornecido através do parâmetro “state”, com o valor “SP”, juntamente com as opções do mapa a ser criado através da estrutura “mapOptions”.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.

A funcionalidade de renderização de mapas com ampliação por pontos está disponível através da operação “GetZoomWindow” e tem como objetivo retornar o endereço de acesso de uma imagem com o mapa renderizado, considerando como entrada uma área ser determinada e um conjunto de pontos para definir a ampliação com o ponto central desejado.

Contrato de entrada – Requisição

O contrato de requisição possui os parâmetros “routeId”, “oldExtent” (Extent), “newExtentInPixels” (Extent), mo (MapOptions) e “token”, sendo estes descritos em detalhe a seguir:

  • routeId

Armazena o identificador de uma rota gerada através das operações do serviço Route

  • oldExtent

Armazena uma implementação da estrutura Extent com as dimensões do mapa através dos valores mínimos e máximos para as coordenadas X e Y.

  • newExtentInPixels

Armazena uma implementação da estrutura Extent com os pontos a serem considerados para realizar a ampliação no mapa, obtendo um ponto central de visualização desejado.

  • mo

Armazena uma implementação da estrutura MapOptions com os parâmetros para geração do mapa.

  • token

Armazena a chave de acesso do requisitante.

Contrato de saída – Resposta

O contrato de resposta possui os parâmetros “url” e “extent” (Extent), sendo estes descritos em detalhe a seguir:

  • url

Armazena o endereço de acesso da imagem com o mapa renderizado.

  • extent

Armazena uma implementação da estrutura “Extent” com os dados da área do mapa.

Consumo

A seguir é apresentando um exemplo de consumo do serviço “MapRender” utilizando a operação “GetZoomWindow”, com o objetivo de obter um mapa renderizado com a área definida e sua ampliação para um ponto específico. A área desejada é representada através da estrutura “Extent” e possui os valores mínimos “-46.65218″ para X e “-23.56501″ para Y, e máximos “-46.61399″ para X e “-23.52279″ para Y. Os pontos de ampliação são representados na mesma estrutura “Extent”, mas através do parâmetro “newExtentInPixels”, contendo os valores “400″ para “XMin” e “YMin” , e “800″ para “XMax” e “YMax”.

Abaixo são apresentandos exemplos de implementação para consumo da operação em diferentes linguagens de programação.

O serviço recebe a requisição, realiza o processamento interno e retorna uma mensagem no formato XML com o resultado da operação.

XML SOAP de resposta:


A seguir são apresentadas as imagens obtidas com um mapa renderizado seguindo o exemplo descrito anteriormente e fazendo uma customização, com o objetivo de notar as diferenças no resultado do mapa gerado a partir da mudança nos parâmetros de entrada da operação.