OpenPLZ (Independent Publisher) (versão prévia)

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:      – Regiões do Azure Governamental      - Regiões do Azure China      - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	OpenPLZ API
URL	https://www.openplzapi.org

Metadados do conector
Publicador	LowCodeInvestigator
Site da Web	https://www.openplzapi.org
Política de privacidade	https://www.openplzapi.org/legal/privacy-policy
Categorias	Dados
Visibilidade	Importante

Conector da API OpenPLZ

O Conector da API OpenPLZ fornece acesso estruturado a códigos postais, ruas, divisões administrativas e dados de localidade para Alemanha, Suíça, Áustria e Liechtenstein. Ele permite que as soluções do Microsoft Power Platform consultem conjuntos de dados de localização confiáveis e normalizados em um formato baseado em REST.

Esse conector expõe várias operações somente leitura que permitem a recuperação de informações hierárquicas, como estados federais, cantões, distritos, municípios, localidades, códigos postais e ruas.

Publicador

OpenPLZ API

---

Funcionalidades Suportadas

O Conector de API OpenPLZ dá suporte aos seguintes recursos:

• Recuperar hierarquias administrativas (estados federais, cantões, distritos, municípios, associações municipais, localidades)
• Executar pesquisas de código postal
• Consultar diretórios de rua
• Trabalhar com cobertura entre países (Alemanha, Suíça, Áustria, Liechtenstein)
• Consumir formatos de resposta JSON consistentes adequados para automação e validação

---

Pré-requisitos

Não há pré-requisitos necessários para usar este conector:

• Nenhuma chave de API
• Nenhum OAuth
• Nenhuma autenticação
• Nenhuma assinatura

A API é acessível publicamente.

---

Como usar o conector

1. Adicione o Conector de API OpenPLZ ao fluxo do Power App ou do Power Automate.
2. Escolha uma das ações disponíveis.
3. Forneça os parâmetros necessários.
4. Use os dados JSON retornados em seu fluxo de trabalho ou aplicativo (por exemplo, para preencher listas suspensas, validar endereços ou armazenar dados de localização estruturados).

---

Informações de conexão

O conector usa uma única conexão anônima. Não são necessárias credenciais.

---

Limitações conhecidas

• API somente leitura (somente operações GET estão disponíveis)
• Limitação de taxa potencial para solicitações excessivas ou de alta frequência
• Nenhum geocoordinado ou dados de limite de polígono
• Nomes administrativos e de localidade seguem convenções de nomenclatura em alemão

---

Documentação da API

• Documentação geral
• Documentação da Alemanha
• Documentação da Suíça
• Documentação da Áustria
• Liechtenstein está incluído na documentação da Suíça

---

Ordem de chamada de API recomendada por país

As seções a seguir descrevem uma sequência recomendada de chamadas à API para recuperar estruturas administrativas hierárquicas em uma ordem lógica para cada país.

Alemanha (DE)

Alemanha – Dados base

• GET /de/FederalStates (Listar todos os estados federais (Alemanha))

Alemanha – Nível estadual federal (usando federalStateKey)

• GET /de/FederalStates/{federalStateKey}/GovernmentRegions (Listar regiões governamentais de um estado federal (Alemanha))
• GET /de/FederalStates/{federalStateKey}/Districts (Listar distritos de um estado federal (Alemanha))
• GET /de/FederalStates/{federalStateKey}/Municipalities (Listar municípios de um estado federal (Alemanha))
• GET /de/FederalStates/{federalStateKey}/MunicipalAssociations (Listar associações municipais de um estado federal (Alemanha))
• GET /de/FederalStates/{federalStateKey}/Localities (Listar localidades de um estado federal (Alemanha))

Alemanha – Nível de Região do Governo (usando governmentRegionKey)

• GET /de/GovernmentRegions/{governmentRegionKey}/Districts (Listar distritos de uma região governamental (Alemanha))
• GET /de/GovernmentRegions/{governmentRegionKey}/Municipalities (Listar municípios de uma região governamental (Alemanha))
• GET /de/GovernmentRegions/{governmentRegionKey}/MunicipalAssociations (Listar associações municipais de uma região governamental (Alemanha))
• GET /de/GovernmentRegions/{governmentRegionKey}/Localities (Listar localidades de uma região governamental (Alemanha))

Alemanha – Nível distrital (usando districtKey)

• GET /de/Districts/{districtKey}/Municipalities (Listar municípios de um distrito (Alemanha))
• GET /de/Districts/{districtKey}/MunicipalAssociations (Listar associações municipais de um distrito (Alemanha))
• GET /de/Districts/{districtKey}/Localities (Localidades de lista de um distrito (Alemanha))

Alemanha – Pontos de extremidade de pesquisa

• GET /de/Localidades (Localidades de pesquisa e códigos postais (Alemanha))
• GET /de/Streets (Ruas de pesquisa (Alemanha))
• GET /de/FullTextSearch (pesquisa de texto completo por ruas, códigos postais e localidades (Alemanha))

---

Liechtenstein (LI)

Liechtenstein – Dados base

• GET /li/Communes (Listar todas as comunas (Liechtenstein))

Liechtenstein – Pontos de extremidade de pesquisa

• GET /li/Localidades (localidades de pesquisa e códigos postais (Liechtenstein))
• GET /li/Streets (Ruas de pesquisa (Liechtenstein))
• GET /li/FullTextSearch (pesquisa de texto completo por ruas (Liechtenstein))

---

Suíça (CH)

Suíça – Dados base

• GET /ch/Cantons (Listar todos os cantões (Suíça))

Suíça – Nível de Cantão (usando cantonKey)

• GET /ch/Cantons/{cantonKey}/Districts (Listar distritos de um cantão (Suíça))
• GET /ch/Cantons/{cantonKey}/Communes (Comunas de lista de um cantão (Suíça))
• GET /ch/Cantons/{cantonKey}/Localities (Listar localidades de um cantão (Suíça))

Suíça – Nível distrital (usando districtKey)

• GET /ch/Districts/{districtKey}/Communes (Comunas de lista de um distrito (Suíça))
• GET /ch/Districts/{districtKey}/Localities (Listar localidades de um distrito (Suíça))

Suíça – Pontos de extremidade de pesquisa

• GET /ch/Localidades (localidades de pesquisa e códigos postais (Suíça))
• GET /ch/Streets (Ruas de pesquisa (Suíça))
• GET /ch/FullTextSearch (pesquisa de texto completo por ruas (Suíça))

---

Áustria (AT)

Áustria – Dados base

• GET /at/FederalProvinces (Listar todas as províncias federais (Áustria))

Áustria – Nível da Província Federal (usando federalProvinceKey)

• GET /at/FederalProvinces/{federalProvinceKey}/Districts (Listar distritos de uma província federal (Áustria))
• GET /at/FederalProvinces/{federalProvinceKey}/Municipalidades (Listar municípios de uma província federal (Áustria))
• GET /at/FederalProvinces/{federalProvinceKey}/Localities (Listar localidades de uma província federal (Áustria))

Áustria – Nível distrital (usando districtKey)

• GET /at/Districts/{districtKey}/Municipalities (Listar municípios de um distrito (Áustria))
• GET /at/Districts/{districtKey}/Localities (Listar localidades de um distrito (Áustria))

Áustria – Pontos de Extremidade de Pesquisa

• GET /at/Localities (localidades de pesquisa e códigos postais (Áustria))
• GET /at/Streets (Ruas de pesquisa (Áustria))
• GET /at/FullTextSearch (pesquisa de texto completo por ruas (Áustria))

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Listar associações municipais de um distrito (Alemanha)	Retorna todas as associações municipais dentro de um distrito alemão.
Listar associações municipais de um estado federal (Alemanha)	Retorna todas as associações municipais dentro de um estado federal alemão.
Listar associações municipais de uma região governamental (Alemanha)	Retorna todas as associações municipais dentro de uma região do governo alemão.
Listar comunas de um cantão (Suíça)	Retorna todas as comunas dentro de um cantão suíço.
Listar comunas de um distrito (Suíça)	Retorna todas as comunas dentro de um distrito suíço.
Listar distritos de um cantão (Suíça)	Retorna todos os distritos dentro de um cantão suíço.
Listar distritos de um estado federal (Alemanha)	Retorna todos os distritos dentro de um estado federal alemão.
Listar distritos de uma província federal (Áustria)	Retorna todos os distritos dentro de uma província federal austríaca.
Listar distritos de uma região do governo (Alemanha)	Retorna todos os distritos dentro de uma região do governo alemão.
Listar localidades de um cantão (Suíça)	Retorna todas as localidades dentro de um cantão suíço.
Listar localidades de um distrito (Alemanha)	Retorna todas as localidades em um distrito alemão.
Listar localidades de um distrito (Suíça)	Retorna todas as localidades dentro de um distrito suíço.
Listar localidades de um distrito (Áustria)	Retorna todas as localidades dentro de um distrito austríaco.
Listar localidades de um estado federal (Alemanha)	Retorna todas as localidades dentro de um estado federal alemão.
Listar localidades de uma província federal (Áustria)	Retorna todas as localidades dentro de uma província federal austríaca.
Listar localidades de uma região governamental (Alemanha)	Retorna todas as localidades dentro de uma região do governo alemão.
Listar municípios de um distrito (Alemanha)	Retorna todos os municípios dentro de um distrito alemão.
Listar municípios de um distrito (Áustria)	Retorna todos os municípios dentro de um distrito austríaco.
Listar municípios de um estado federal (Alemanha)	Retorna todos os municípios dentro de um estado federal alemão.
Listar municípios de uma província federal (Áustria)	Retorna todos os municípios de uma província federal austríaca.
Listar municípios de uma região do governo (Alemanha)	Retorna todos os municípios dentro de uma região do governo alemão.
Listar regiões governamentais de um estado federal (Alemanha)	Retorna todas as regiões do governo dentro de um estado federal alemão.
Listar todas as comunas (Liechtenstein)	Retorna todas as 11 comunas do Principado de Liechtenstein.
Listar todas as províncias federais (Áustria)	Retorna todas as 9 províncias federais da Áustria.
Listar todos os cantões (Suíça)	Retorna todos os 26 cantões da Suíça.
Listar todos os estados federais (Alemanha)	Retorna todos os estados federais alemães.
Localidades de pesquisa e códigos postais (Alemanha)	Pesquisa localidades na Alemanha por código postal e/ou nome de localidade. Ambos os parâmetros dão suporte a expressões regulares.
Pesquisa de texto completo por ruas, códigos postais e localidades (Alemanha)	Pesquisa de texto completo entre nomes de rua, códigos postais e nomes de localidade na Alemanha.
Pesquisa de texto completo por ruas (Liechtenstein)	Pesquisa de texto completo entre o nome da rua, o código postal e o nome da localidade em Liechtenstein.
Pesquisa de texto completo por ruas (Suíça)	Pesquisa de texto completo entre nomes de rua, códigos postais e nomes de localidade na Suíça.
Pesquisa de texto completo por ruas (Áustria)	Pesquisa de texto completo entre o nome da rua, o código postal e o nome da localidade para o diretório de dados austríaco.
Pesquisar localidades e códigos postais (Liechtenstein)	Pesquisa localidades em Liechtenstein por código postal e/ou nome de localidade. Há suporte para expressões regulares.
Pesquisar localidades e códigos postais (Suíça)	Procura localidades na Suíça por código postal e/ou nome de localidade. Ambos os parâmetros dão suporte a expressões regulares.
Pesquisar localidades e códigos postais (Áustria)	Procura localidades na Áustria por código postal e/ou nome de localidade. Ambos os parâmetros dão suporte a expressões regulares.
Ruas de pesquisa (Alemanha)	Procura ruas na Alemanha por nome de rua e/ou código postal e/ou nome de localidade. Todos os parâmetros dão suporte a expressões regulares.
Ruas de pesquisa (Liechtenstein)	Procura ruas em Liechtenstein por nome de rua e/ou cep e/ou localidade. Há suporte para expressões regulares.
Ruas de pesquisa (Suíça)	Procura ruas na Suíça por nome de rua e/ou cep e/ou nome de localidade. Todos os parâmetros dão suporte a expressões regulares.
Ruas de pesquisa (Áustria)	Procura ruas na Áustria por nome de rua e/ou cep e/ou nome de localidade. Todos os parâmetros dão suporte a expressões regulares.

Listar associações municipais de um distrito (Alemanha)

Listar associações municipais de um estado federal (Alemanha)

Listar associações municipais de uma região governamental (Alemanha)

Listar comunas de um cantão (Suíça)

Listar comunas de um distrito (Suíça)

Listar distritos de um cantão (Suíça)

Listar distritos de um estado federal (Alemanha)

Listar distritos de uma província federal (Áustria)

Listar distritos de uma região do governo (Alemanha)

Listar localidades de um cantão (Suíça)

Listar localidades de um distrito (Alemanha)

Listar localidades de um distrito (Suíça)

Listar localidades de um distrito (Áustria)

Listar localidades de um estado federal (Alemanha)

Listar localidades de uma província federal (Áustria)

Listar localidades de uma região governamental (Alemanha)

Listar municípios de um distrito (Alemanha)

Listar municípios de um distrito (Áustria)

Listar municípios de um estado federal (Alemanha)

Listar municípios de uma província federal (Áustria)

Listar municípios de uma região do governo (Alemanha)

Listar regiões governamentais de um estado federal (Alemanha)

Listar todas as comunas (Liechtenstein)

Listar todas as províncias federais (Áustria)

Listar todos os cantões (Suíça)

Listar todos os estados federais (Alemanha)

Localidades de pesquisa e códigos postais (Alemanha)

Pesquisa de texto completo por ruas, códigos postais e localidades (Alemanha)

Pesquisa de texto completo por ruas (Liechtenstein)

Pesquisa de texto completo por ruas (Suíça)

Pesquisa de texto completo por ruas (Áustria)

Pesquisar localidades e códigos postais (Liechtenstein)

Pesquisar localidades e códigos postais (Suíça)

Pesquisar localidades e códigos postais (Áustria)

Ruas de pesquisa (Alemanha)

Ruas de pesquisa (Liechtenstein)

Ruas de pesquisa (Suíça)

Ruas de pesquisa (Áustria)

Definições

FederalState

GovernmentRegion

GovernmentRegionSummary

FederalStateSummary

Distrito

DistrictSummary

MunicipalAssociation

MunicipalAssociationSummary

Município

MunicípioSummary

Localidade

Rua

ComuneLI

LocalidadeLI

StreetLI

CantonCH

CantonCHSummary

DistrictCH

DistrictCHSummary

CommuneCH

ComuneCHSummary

LocalidadeCH

StreetCH

FederalProvinceAT

FederalProvinceATSummary

DistrictAT

DistrictATSummary

MunicípioAT

MunicipalityATSummary

LocalityAT

StreetAT