From 3b8f2504e639f716f284b8efebb6b41c057521f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pimentel=20Ferreira?= Date: Sat, 18 May 2024 23:02:10 +0200 Subject: [PATCH] #117 --- .gitignore | 1 + docs/dist/index.html | 1049 ------------------------------------------ docs/template.hbs | 65 +-- 3 files changed, 18 insertions(+), 1097 deletions(-) delete mode 100644 docs/dist/index.html diff --git a/.gitignore b/.gitignore index 626584e27ea..69a68befb0d 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ geoapi.pt.code-workspace # generated from redocly redoc-static.html docs/redocTemplate.temp.hbs +docs/dist/* credentials.json counters.json diff --git a/docs/dist/index.html b/docs/dist/index.html deleted file mode 100644 index 526fbc55f51..00000000000 --- a/docs/dist/index.html +++ /dev/null @@ -1,1049 +0,0 @@ - - - - - Documentação do GEO API PT - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

- - GEO API PT - -

-
Dados gratuitos de Portugal sobre regiões administrativas oficiais, altimetria, georreferenciação, censos e códigos postais
- - -
- -
- Pedir chave - Self-hosting - Uptime - Documentação -
-
- -
- - -
-
-

Documentação da API JSON

-
-
-

Para resultados em JSON pode usar uma das seguintes opções:

-

Se estiver a usar a API pública:

-
- -
-

Se estiver a usar a API em self-hosting:

-
-
    -
  • - adicionar a variável json=1 ao pedido GET, ex: /cp/2495-300?json=1; ou
    • -
  • - colocar Accept: application/json no cabeçalho HTTP do pedido
    • -
-
-

Para resultados em JSON "bonitos", i.e., pseudo-resposta em JSON mas em formato HTML para melhor vizualização: -

- -
-
-
-

Documentação simplificada

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CaminhoPropósitoExemplo
Geocodificação reversa
/gps/{latitude},{longitude}Distrito, município, freguesia, sub(secção) estatística, artéria, uso do solo, altitude e código postal, através de coordenadas GPS/gps/38.748406,-9.102984
/gps/{latitude},{longitude}/detalhesO mesmo que o anterior, mas com detalhes adicionais sobre município, freguesia, sub(secção) estatística e uso do solo/gps/38.748406,-9.102984/detalhes
/gps/{latitude},{longitude}/baseApenas distrito, município e freguesia (pedido muito mais rápido)/gps/38.748406,-9.102984/base
/gps/{latitude},{longitude}/base/detalhesApenas distrito, município e freguesia (pedido muito mais rápido) com detalhes sobre município e freguesia/gps/38.748406,-9.102984/base/detalhes
Divisões administrativas
/municipiosLista de todos os Municípios/municipios
/municipio/{município}Detalhes sobre Município/municipio/évora
/municipio/{município}/freguesiasLista de Freguesias no Município/municipio/porto/freguesias
/municipios/freguesiasLista de todos os Municípios com respectivas freguesias/municipios/freguesias
/freguesiasLista de todas as Freguesias/freguesias
/freguesia/{freguesia}Detalhes sobre Freguesia/freguesia/serzedelo
/municipio/{município}/freguesia/{freguesia}Detalhes sobre Freguesia de um Município/municipio/guimarães/freguesia/serzedelo
/distritosLista de todos os Distritos/distritos
/distrito/{distrito}Detalhes sobre o Distrito/distrito/faro
/distritos/municipiosLista de todos os Distritos com respetivos Municípios/distritos/municipios
/distrito/{distrito}/municipiosLista de Municípios do Distrito/distrito/lisboa/municipios
/distrito/{distrito}/freguesiasLista de Freguesias do Distrito/distrito/braga/freguesias
Altimetria
/distrito/{distrito}/altimetriaAltimetria sobre Distrito/distrito/porto/altimetria
/municipio/{município}/altimetriaAltimetria sobre Município/municipio/porto/altimetria
/municipio/{município}/freguesia/{freguesia}/altimetriaAltimetria sobre Freguesia/municipio/guimarães/freguesia/serzedelo/altimetria
Divisões estatísticas
/municipio/{município}/freguesia/{freguesia}/sec/{secção}Secção estatística de determinada Freguesia de um Município/municipio/lisboa/freguesia/marvila/sec/011
/municipio/{município}/freguesia/{freguesia}/sec/{secção}/ss/{subsecção}Subsecção estatística de determinada Secção de determinada Freguesia de um Município/municipio/lisboa/freguesia/marvila/sec/011/ss/06
/municipio/{município}/freguesia/{freguesia}/seccoesSecções estatísticas de determinada Freguesia de um Município/municipio/lisboa/freguesia/marvila/seccoes
/municipio/{município}/freguesia/{freguesia}/subseccoesSubecções estatísticas de determinada Freguesia de um Município/municipio/lisboa/freguesia/marvila/subseccoes
Códigos Postais
/codigos_postaisTodos os Códigos Postais organizados em árvore/codigos_postais
/codigos_postais/baseLista simples de todos os Códigos Postais CP4-CP3/codigos_postais/base
/cp/{CP4-CP3}Detalhes sobre Código Postal CP4-CP3/cp/2495-300
/cp/{CP4}Detalhes sobre Código Postal CP4/cp/2495
-
-
- -

- -
-

Documentação completa

-
- -
API docs by Redocly

GEO API PT (1.0)

Download OpenAPI specification:Download

License: GNU General Public License v3.0

Dados de acesso gratuito para Portugal sobre regiões administrativas oficiais, georreferenciação, censos e códigos postais

-

Distrito, Município e Freguesia através de coordenadas GPS nos parâmetros da query

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
lat
required
string
Example: lat=40.153687

Latitude do ponto

-
lon
required
string
Example: lon=-8.514602

Longitude do ponto

-
detalhes
string
Example: detalhes=1

Ativa apresentação de detalhes de Freguesia e Município

-
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-
ext-apis
string
Default: "1"
Enum: "0" "1" "true" "false"
Examples:
  • ext-apis=0 - Não recorre a APIs externas
  • ext-apis=false - Não recorre a APIs externas

Quando desativada, não recorre a APIs externas tornando o pedido muito mais rápido

-

Responses

Response samples

Content type
application/json
{
  • "lon": -9.102984,
  • "lat": 38.748406,
  • "distrito": "Lisboa",
  • "concelho": "Lisboa",
  • "freguesia": "Marvila",
  • "uso": "Tecido edificado contínuo predominantemente vertical",
  • "SEC": 11,
  • "SS": 6,
  • "rua": "Rua Fernando Maurício",
  • "n_porta": 30,
  • "CP": "1950-449"
}

Distrito, município, freguesia, uso do solo, rua, número de porta, altitude e código postal através de coordenadas GPS

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
coordenadas
required
string
Example: 40.153687,-8.514602

Coordenadas (latitude e longitude) do ponto

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-
ext-apis
string
Default: "1"
Enum: "0" "1" "true" "false"
Examples:
  • ext-apis=0 - Não recorre a APIs externas
  • ext-apis=false - Não recorre a APIs externas

Quando desativada, não recorre a APIs externas tornando o pedido muito mais rápido

-

Responses

Response samples

Content type
application/json
{
  • "lon": -9.102984,
  • "lat": 38.748406,
  • "distrito": "Lisboa",
  • "concelho": "Lisboa",
  • "freguesia": "Marvila",
  • "uso": "Tecido edificado contínuo predominantemente vertical",
  • "SEC": 11,
  • "SS": 6,
  • "rua": "Rua Fernando Maurício",
  • "n_porta": 30,
  • "altitude_m": 66,
  • "CP": "1950-449"
}

Distrito, município, freguesia, uso do solo, rua, número de porta, altitude e código postal através de coordenadas GPS, com respetivos detalhes

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
coordenadas
required
string
Example: 40.153687,-8.514602

Coordenadas (latitude e longitude) do ponto

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-
ext-apis
string
Default: "1"
Enum: "0" "1" "true" "false"
Examples:
  • ext-apis=0 - Não recorre a APIs externas
  • ext-apis=false - Não recorre a APIs externas

Quando desativada, não recorre a APIs externas tornando o pedido muito mais rápido

-

Responses

Response samples

Content type
application/json
{
  • "lon": -9.102984,
  • "lat": 38.748406,
  • "distrito": "Lisboa",
  • "concelho": "Lisboa",
  • "freguesia": "Marvila",
  • "detalhesFreguesia": {
    },
  • "detalhesMunicipio": {
    },
  • "uso": "Tecido edificado contínuo predominantemente vertical",
  • "carta_solo": {
    },
  • "SEC": 11,
  • "SS": 6,
  • "Detalhes Subsecção Estatística": {
    },
  • "rua": "Rua Fernando Maurício",
  • "n_porta": 30,
  • "CP": "1950-449"
}

Distrito, Município e Freguesia através de coordenadas GPS

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
coordenadas
required
string
Example: 40.153687,-8.514602

Coordenadas (latitude e longitude) do ponto

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-
ext-apis
string
Default: "1"
Enum: "0" "1" "true" "false"
Examples:
  • ext-apis=0 - Não recorre a APIs externas
  • ext-apis=false - Não recorre a APIs externas

Quando desativada, não recorre a APIs externas tornando o pedido muito mais rápido

-

Responses

Response samples

Content type
application/json
{
  • "lon": -9.102984,
  • "lat": 38.748406,
  • "distrito": "Lisboa",
  • "concelho": "Lisboa",
  • "freguesia": "Marvila"
}

Distrito, Município e Freguesia através de coordenadas GPS, com detalhes sobre respectivos Município e Freguesia

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
coordenadas
required
string
Example: 40.153687,-8.514602

Coordenadas (latitude e longitude) do ponto

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-
ext-apis
string
Default: "1"
Enum: "0" "1" "true" "false"
Examples:
  • ext-apis=0 - Não recorre a APIs externas
  • ext-apis=false - Não recorre a APIs externas

Quando desativada, não recorre a APIs externas tornando o pedido muito mais rápido

-

Responses

Response samples

Content type
application/json
{
  • "lon": -9.102984,
  • "lat": 38.748406,
  • "distrito": "Lisboa",
  • "concelho": "Lisboa",
  • "freguesia": "Marvila",
  • "detalhesFreguesia": {
    },
  • "detalhesMunicipio": {
    }
}

Município (obtido via parâmetros da query) ou Lista de todos os Municípios (sem parâmetros na query)

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
nome
string

Nome do Município

-
codigo
integer

Código do Município

-
nif
integer

NIF do Município

-
codigopostal
string

Código Postal do Município

-
email
string

Email do Município

-
telefone
integer

Telefone do Município

-
fax
integer

Fax do Município

-
sitio
string

Website do Município

-
codigoine
integer

Código INE do Município

-
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
Example
{
  • "codigo": 2643,
  • "nif": 504828576,
  • "rua": "Praça do Sertório",
  • "localidade": "EVORA",
  • "codigopostal": "7004-506",
  • "descrpostal": "EVORA",
  • "email": "cmevora@cm-evora.pt",
  • "telefone": 266777000,
  • "fax": 266702950,
  • "sitio": "www.cm-evora.pt",
  • "areaha": 1307.03,
  • "populacao": 56596,
  • "eleitores": 47923,
  • "codigoine": 705,
  • "nome": "Évora",
  • "distrito": "ÉVORA",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojsons": {
    }
}

Lista de todos os Municípios com respetivas freguesias

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Detalhes sobre Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: évora

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "codigo": 2643,
  • "nif": 504828576,
  • "rua": "Praça do Sertório",
  • "localidade": "EVORA",
  • "codigopostal": "7004-506",
  • "descrpostal": "EVORA",
  • "email": "cmevora@cm-evora.pt",
  • "telefone": 266777000,
  • "fax": 266702950,
  • "sitio": "www.cm-evora.pt",
  • "areaha": 1307.03,
  • "populacao": 56596,
  • "eleitores": 47923,
  • "codigoine": 705,
  • "nome": "Évora",
  • "distrito": "ÉVORA",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojsons": {
    }
}

Detalhes sobre Município (descontinuado, usar antes /municipio/{municipio}) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: évora

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Altimetria sobre Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: évora

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "altitude": {},
  • "codigo": 2643,
  • "nif": 504828576,
  • "rua": "Praça do Sertório",
  • "localidade": "EVORA",
  • "codigopostal": "7004-506",
  • "descrpostal": "EVORA",
  • "email": "cmevora@cm-evora.pt",
  • "telefone": 266777000,
  • "fax": 266702950,
  • "sitio": "www.cm-evora.pt",
  • "areaha": 1307.03,
  • "populacao": 56596,
  • "eleitores": 47923,
  • "codigoine": 705,
  • "nome": "Évora",
  • "distrito": "ÉVORA",
  • "geojson": {
    }
}

Lista de Freguesias no Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: évora

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "nome": "Porto",
  • "freguesias": [
    ],
  • "geojsons": {
    }
}

Lista de Freguesias no Município (descontinuado, usar antes /municipio/{municipio}/freguesias) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: évora

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Lista de todas as Freguesias

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
nome
string

Nome da Freguesia

-
municipio
string

Município da Freguesia

-
codigo
integer

Código da Freguesia

-
nif
integer

NIF da Freguesia

-
codigopostal
string

Código Postal da Freguesia

-
email
string

Email da Freguesia

-
telefone
integer

Telefone da Freguesia

-
fax
integer

Fax da Freguesia

-
sitio
string

Website da Freguesia

-
codigoine
integer

Código INE da Freguesia

-
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
Example
{
  • "codigo": 7821,
  • "nif": 507330609,
  • "rua": "Avª. João Paulo II lote 526 - 1º A",
  • "localidade": "Marvila",
  • "codigopostal": "1950-159",
  • "descrpostal": "LISBOA",
  • "email": "info@jf-marvila.pt",
  • "telefone": 218310350,
  • "fax": 218310359,
  • "sitio": "www.jf-marvila.pt",
  • "codigoine": 110621,
  • "eleitores2011": 37125,
  • "populacao2011": 38767,
  • "areaha": 637.42,
  • "nomecompleto": "Marvila",
  • "nome": "Marvila",
  • "municipio": "Lisboa",
  • "nomecompleto2": "Marvila",
  • "nomecompleto3": "Marvila",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojson": {
    }
}

Detalhes sobre Freguesia(s)

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
freguesia
required
string
Example: serzedelo

Freguesia

-
query Parameters
municipio
string

Município da Freguesia

-
codigo
integer

Código da Freguesia

-
nif
integer

NIF da Freguesia

-
codigopostal
string

Código Postal da Freguesia

-
email
string

Email da Freguesia

-
telefone
integer

Telefone da Freguesia

-
fax
integer

Fax da Freguesia

-
sitio
string

Website da Freguesia

-
codigoine
integer

Código INE da Freguesia

-
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
Example
{
  • "codigo": 7821,
  • "nif": 507330609,
  • "rua": "Avª. João Paulo II lote 526 - 1º A",
  • "localidade": "Marvila",
  • "codigopostal": "1950-159",
  • "descrpostal": "LISBOA",
  • "email": "info@jf-marvila.pt",
  • "telefone": 218310350,
  • "fax": 218310359,
  • "sitio": "www.jf-marvila.pt",
  • "codigoine": 110621,
  • "eleitores2011": 37125,
  • "populacao2011": 38767,
  • "areaha": 637.42,
  • "nomecompleto": "Marvila",
  • "nome": "Marvila",
  • "municipio": "Lisboa",
  • "nomecompleto2": "Marvila",
  • "nomecompleto3": "Marvila",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojson": {
    }
}

Detalhes sobre Freguesia(s) (descontinuado, usar antes /freguesia/{freguesia}) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
freguesia
required
string
Example: serzedelo

Freguesia

-
query Parameters
municipio
string

Município da Freguesia

-
codigo
integer

Código da Freguesia

-
nif
integer

NIF da Freguesia

-
codigopostal
string

Código Postal da Freguesia

-
email
string

Email da Freguesia

-
telefone
integer

Telefone da Freguesia

-
fax
integer

Fax da Freguesia

-
sitio
string

Website da Freguesia

-
codigoine
integer

Código INE da Freguesia

-
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Detalhes sobre Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: guimarães

Município

-
freguesia
required
string
Example: serzedelo

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "codigo": 7821,
  • "nif": 507330609,
  • "rua": "Avª. João Paulo II lote 526 - 1º A",
  • "localidade": "Marvila",
  • "codigopostal": "1950-159",
  • "descrpostal": "LISBOA",
  • "email": "info@jf-marvila.pt",
  • "telefone": 218310350,
  • "fax": 218310359,
  • "sitio": "www.jf-marvila.pt",
  • "codigoine": 110621,
  • "eleitores2011": 37125,
  • "populacao2011": 38767,
  • "areaha": 637.42,
  • "nomecompleto": "Marvila",
  • "nome": "Marvila",
  • "municipio": "Lisboa",
  • "nomecompleto2": "Marvila",
  • "nomecompleto3": "Marvila",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojson": {
    }
}

Detalhes sobre Freguesia de um determinado Município (descontinuado, usar antes /municipio/{municipio}/freguesia/{freguesia}) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: guimarães

Município

-
freguesia
required
string
Example: serzedelo

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Detalhes sobre Freguesia de um determinado Município (descontinuado, usar antes /municipio/{municipio}/freguesia/{freguesia}) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: guimarães

Município

-
freguesia
required
string
Example: serzedelo

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Detalhes sobre Freguesia de um determinado Município (descontinuado, usar antes /municipio/{municipio}/freguesia/{freguesia}) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: guimarães

Município

-
freguesia
required
string
Example: serzedelo

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Altimetria de uma Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: guimarães

Município

-
freguesia
required
string
Example: serzedelo

Município

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "altitude": {},
  • "codigo": 7821,
  • "nif": 507330609,
  • "rua": "Avª. João Paulo II lote 526 - 1º A",
  • "localidade": "Marvila",
  • "codigopostal": "1950-159",
  • "descrpostal": "LISBOA",
  • "email": "info@jf-marvila.pt",
  • "telefone": 218310350,
  • "fax": 218310359,
  • "sitio": "www.jf-marvila.pt",
  • "codigoine": 110621,
  • "eleitores2011": 37125,
  • "populacao2011": 38767,
  • "areaha": 637.42,
  • "nomecompleto": "Marvila",
  • "nome": "Marvila",
  • "municipio": "Lisboa",
  • "nomecompleto2": "Marvila",
  • "nomecompleto3": "Marvila",
  • "geojson": {
    }
}

Lista de todos os Distritos com respectivos detalhes

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista de todos os Distritos

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Lista de todos os Distritos com respetivos Municípios

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Dados do Distrito

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: porto

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "distrito": "Porto",
  • "codigoine": "11",
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "geojson": { }
}

Altimetria do Distrito

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: porto

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{}

Lista de Municípios do Distrito

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: porto

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "distrito": "Lisboa",
  • "municipios": [
    ]
}

Lista de Municípios do Distrito (descontinuado, usar antes /distrito/{distrito}/municipios) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: porto

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Lista de Freguesias do Distrito

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: lisboa

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "distrito": "Lisboa",
  • "freguesias": [
    ]
}

Lista de Freguesias do Distrito (descontinuado, usar antes /distrito/{distrito}/freguesias) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
distrito
required
string
Example: lisboa

Distrito

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Detalhes sobre Secção estatística de uma Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: lisboa

Município

-
freguesia
required
string
Example: marvila

Freguesia

-
seccao
required
string
Example: 001

Secção

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "freguesia": {
    },
  • "municipio": {
    },
  • "geojson": {
    },
  • "censos2011": {
    },
  • "censos2021": {
    },
  • "SEC": "string",
  • "DTMNFRSEC": "string"
}

Secções estatísticas de uma Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: lisboa

Município

-
freguesia
required
string
Example: marvila

Freguesia

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "freguesia": {
    },
  • "municipio": {
    },
  • "geojson": { }
}

Detalhes sobre Subsecção estatística de uma Secção de uma Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: lisboa

Município

-
freguesia
required
string
Example: marvila

Freguesia

-
seccao
required
string
Example: 011

Secção

-
subseccao
required
string
Example: 06

Subsecção

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "freguesia": {
    },
  • "municipio": {
    },
  • "geojson": {
    },
  • "censos2021": {
    },
  • "SS": "string",
  • "BGRI": "string"
}

Subsecções estatísticas de uma Freguesia de um determinado Município

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
municipio
required
string
Example: lisboa

Município

-
freguesia
required
string
Example: marvila

Freguesia

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "freguesia": {
    },
  • "municipio": {
    },
  • "geojson": { }
}

Detalhes sobre Código Postal (CP4 ou CP7)

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
cp
required
string/^\d{4}(\p{Dash}?\d{3})?$/u
Examples:
  • 2495 - Código Postal CP4
  • 2495-300 - Código Postal CP7

Código Postal

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
Example
{
  • "CP4": 1950,
  • "CP3": [
    ],
  • "Distrito": "Lisboa",
  • "Concelho": "Lisboa",
  • "Localidade": "Lisboa",
  • "Designação Postal": "LISBOA",
  • "partes": [
    ],
  • "ruas": [
    ],
  • "centro": [
    ],
  • "poligono": [
    ],
  • "centroide": [
    ],
  • "centroDeMassa": [
    ],
  • "pontos": [
    ]
}

Detalhes sobre Código Postal (CP4 ou CP7) Deprecated

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
path Parameters
cp
required
string/^\d{4}(\p{Dash}?\d{3})?$/u
Examples:
  • 2495 - Código Postal CP4
  • 2495-300 - Código Postal CP7

Código Postal

-
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Todos os Códigos Postais

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
{
  • "cp4": {
    }
}

Lista simples de todos os Códigos Postais

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery
query Parameters
json
string
Default: "0"
Enum: "0" "1" "true" "false" "belo" "beauty"
Examples:
  • json=1 - Ativa resposta em JSON
  • json=true - Ativa resposta em JSON
  • json=belo - Apresenta a hipotética resposta JSON de forma bonita e legível em HTML

Ativa resposta em JSON

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Pedidos por hora

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery

Responses

Response samples

Content type
application/json
{
  • "schemaVersion": 1,
  • "label": "Requests on last hour",
  • "message": 630,
  • "color": "orange"
}

Pedidos por dia

Authorizations:
ApiKeyAuthInHeaderApiKeyAuthInQuery

Responses

Response samples

Content type
application/json
{
  • "schemaVersion": 1,
  • "label": "Requests on last day",
  • "message": 7551,
  • "color": "orange"
}
- - -
- -
- - - - diff --git a/docs/template.hbs b/docs/template.hbs index 173d32e8d5d..9fd9b31908c 100644 --- a/docs/template.hbs +++ b/docs/template.hbs @@ -1,55 +1,24 @@ - - {{{ pageTitle }}} + {{> htmlHead}} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \{{{redocHead}}} - - + + + \{{{redocHead}}} + + {{> bodyHeader}}