Swagger – API do Mapa.Urbis

Diretrizes e acesso à documentação Swagger da API do Mapa.Urbis.

Visão geral

A API do Mapa.Urbis disponibiliza endpoints para acesso a dados geoespaciais, camadas urbanísticas, informações territoriais e integrações com sistemas da Prefeitura de São Paulo.

A documentação oficial da API é disponibilizada no formato Swagger, permitindo exploração interativa dos endpoints e testes diretos pelo navegador.


Documentação interativa (Swagger)

O Swagger apresenta de forma estruturada:

  • Lista completa de endpoints disponíveis
  • Parâmetros de entrada e validações
  • Modelos de resposta
  • Exemplos de requisições e retornos
  • Testes interativos (GET, POST, etc.)

👉 Acesse o Swagger da API do Mapa.Urbis:
https://api.mapa.urbis.prefeitura.sp.gov.br/swagger/docs

💡 Recomendação: utilize o Swagger para compreender os contratos da API antes de iniciar qualquer integração.


Diretrizes de uso

Ao consumir a API do Mapa.Urbis, siga as diretrizes abaixo:

  • Utilize filtros e parâmetros para reduzir o volume de dados retornados
  • Evite requisições repetitivas ou automatizadas em curto intervalo
  • Sempre valide os dados retornados pela API
  • Consulte a documentação das camadas para entender limitações de cobertura

Ambientes

Atualmente, a documentação Swagger apresentada refere-se ao ambiente oficial da API do Mapa.Urbis.

Em ambientes de desenvolvimento ou homologação, a estrutura dos endpoints segue o mesmo padrão descrito no Swagger.


Suporte

Em caso de dúvidas, erros ou comportamento inesperado:

  • Utilize a Central de Ajuda disponível na plataforma Urbis
  • Informe o endpoint utilizado
  • Descreva os parâmetros enviados e o erro retornado
  • Sempre que possível, inclua exemplos de requisição

Próximos passos

  • Explorar os endpoints disponíveis no Swagger
  • Validar respostas e modelos de dados
  • Integrar a API aos fluxos de análise ou sistemas externos