Introdução
Você pode criar um conector personalizado como software livre e certificá-lo para disponibilizá-lo a todos os usuários. Um conector como software livre sempre será publicado no repositório GitHub do Microsoft Power Platform.
Repositório do GitHub do Microsoft Power Platform
O repositório do GitHub do Microsoft Power Platform tem vários tipos de conectores que podem ser divididos em dois grupos: personalizados e certificados.
Os conectores personalizados são aqueles que qualquer usuário pode importar do repositório do GitHub para um ambiente e usá-lo ou fazer contribuições a seu conector para você considerar adotá-lo. Quando você cria um conector personalizado, ele fica disponível apenas para você e os usuários com quem você o compartilha explicitamente. Adicionar o conector personalizado ao repositório do GitHub do Microsoft Power Platform ajuda a facilitar a importação do conector para o ambiente.
Quando certificar um conector personalizado
Para que um conector fique visível na lista de conectores oficiais, para qualquer usuário do Microsoft Power Automate, do Microsoft Power Apps ou dos Aplicativos Lógicos do Microsoft Azure, você precisa certificar o conector personalizado.
Existem muitas razões para certificar seu conector personalizado. As principais delas são a facilidade de uso, visibilidade e expansão do alcance da API. Certifique seu conector personalizado se ele oferecer acesso a uma API que é útil para um público-alvo amplo e não estiver voltada ao uso interno. Não é necessário hospedar o serviço subjacente da API nas tecnologias da Microsoft. Na verdade, os conectores ajudam a integrar as soluções do Microsoft Power Platform a soluções que não são da Microsoft. Você pode certificar conectores para APIs gratuitas ou pagas.
A Microsoft examina os conectores certificados para garantir que atendam aos critérios de certificação antes da publicação. Há dois tipos de editores de conectores disponíveis:
Editores Verificados: um requisito fundamental de editores verificados é que você precisa ter o serviço subjacente ou apresentar direitos explícitos para usar a API e fornecer um cenário de usuário que se adeque apropriadamente aos produtos.
Editores Independentes: esse tipo de editor não tem o serviço subjacente por trás do conector. Por exemplo, um usuário de uma API que não seja afiliado à empresa pode enviar um conector para a API para certificação. Esse tipo permite que os usuários da comunidade participem do ecossistema do conector do Microsoft Power Platform.
A certificação inicial e as atualizações para o conector são gratuitas. A próxima unidade explica em mais detalhes o processo de certificação.
Quando criar um conector personalizado como software livre
Todo conector personalizado que você cria é pode se tornar um software livre se você determinar que outras pessoas podem se beneficiar do seu uso. Para certificar um conector, a primeira etapa é fazer com a que definição seja open-source. Em seguida, você precisa verificar se há uma definição de conector personalizado existente no repositório para a API que você está criando. Se você encontrar uma definição já existente, recomendamos que, em vez de criar um conector duplicado, você contribua com ela. Para isso, envie uma solicitação de pull.
Os exemplos a seguir descrevem quando a criação de um conector personalizado de software livre é mais e menos ideal.
Candidato ideal como software livre | Candidato ruim como software livre |
---|---|
Conector para uma API que está disponível publicamente | Conector para uma API privada que está disponível apenas na sua rede corporativa |
A maioria das contribuições exige que você concorde com um CLA (Contrato de Licença de Colaborador). Esse contrato declara que você tem o direito e, de fato, os direitos de usar sua contribuição. Para obter mais informações, consulte o Contrato de Licença do Colaborador.
O repositório do GitHub tem três pastas principais que contêm os conectores:
custom-connectors
independent-publisher-connectors
certified-connectors
A pasta custom-connectors contém exemplos de conectores totalmente funcionais que você pode implantar no Microsoft Power Platform para extensão e uso. Esses exemplos não são conectores certificados, mas eles foram criados e mantidos pela comunidade de código aberto para oferecer cenários úteis ou exemplos de conceitos de conectores. Esses conectores não são implantados no Power Apps, no Power Automate e nos Aplicativos Lógicos por padrão, o que os torna diferentes das outras duas pastas.
A pasta independent-publisher-connectors contém conectores que são enviados por editores que não têm o serviço subjacente por trás do conector. Esses conectores são implantados e estão disponíveis no Microsoft Power Platform como conectores premium. Qualquer pessoa pode enviar um novo conector para essa pasta, adicionar funcionalidade aos conectores nela e resolver problemas relacionados aos conectores na pasta. A Comunidade de Conectores de Editores Independentes, que inclui editores independentes e coordenadores de projeto, gerencia essa pasta. A Equipe de Certificação do Microsoft Connector mantém a ramificação mestre para garantir que a versão do conector seja idêntica àquela implantada no Microsoft Power Platform. Os mantenedores do conector e a equipe de certificação do Microsoft Connector mantêm a ramificação dev para permitir o desenvolvimento comunitário do conector antes da certificação e implantação de uma versão.
A pasta certified-connectors contém conectores certificados que já foram implantados e que estão disponíveis para uso, imediatamente, no Microsoft Power Platform. Um requisito do programa de certificação de conectores da Microsoft é que os novos conectores certificados devem ser de código aberto para contribuições da comunidade. A equipe de certificação de conectores da Microsoft gerencia a pasta certified-connectors para garantir que, na branch master, a versão do conector seja idêntica àquela implantada no Microsoft Power Platform. O proprietário do conector e a equipe de Certificação do Microsoft Connector mantêm a ramificação dev para permitir o desenvolvimento da comunidade do conector antes da certificação e implantação de uma versão.
Para contribuir com o repositório GitHub, você pode começar fazendo sua própria cópia (ou criando uma fork) do repositório. As etapas são explicadas em Como criar uma fork. Após criar uma fork, você pode preparar seu conector para contribuição usando uma solicitação pull. Você pode baixar seus ativos de conector usando a CLI de Conectores do Microsoft Power Platform.
CLI de Conectores do Microsoft Power Platform
Para trabalhar com seus ativos de conector, baixe a CLI de Conectores do Microsoft Power Platform usando as instruções de instalação para a CLI de Conectores do Microsoft Power Platform.
Observação
O outro nome para a CLI de Conectores do Microsoft Power Platform é paconn
.
Entre usando a CLI de Conectores do Microsoft Power Platform
Para baixar seus arquivos de conector, você deve estar conectado com a CLI de Conectores do Microsoft Power Platform. Entre executando o seguinte comando:
paconn login
Esse comando solicita que você entre usando o processo de entrada do código do dispositivo. Siga o prompt para o processo de entrada.
Baixar usando a CLI de Conectores do Microsoft Power Platform
Para preparar os arquivos necessários para criar um conector de código aberto, use o comando paconn download
da CLI de Conectores do Microsoft Power Platform.
Execute o comando abaixo para baixar os arquivos de conectores personalizados:
paconn download
Quando você executa esse comando, uma entrada de dispositivo é iniciada para permitir que paconn acesse o ambiente do Microsoft Power Platform em seu nome. Após a autenticação, paconn fornece uma lista de ambientes para seleção, seguida por uma lista de conectores para seleção.
Se você souber sua ID de ambiente e ID de conector, use a seguinte sintaxe de linha de comando para evitar a solicitação:
paconn download -e [Microsoft Power Platform Environment GUID] -c [Connector ID]
O download inclui quatro arquivos:
apiDefintion.swagger.json – a definição de OpenAPI para seu conector, que inclui todos os gatilhos e ações, por exemplo.
apiProperties.json – define modelos de política e outras propriedades de conectores estendidos que não fazem parte das especificações de OpenAPI.
icon.png – um pequeno ícone que representa o serviço no designer quando o conector é usado.
settings.json – esse arquivo é usado em vez de fornecer parâmetros para
paconn
.
Você dará mais visibilidade à sua API se tiver um conector personalizado open-source certificado. Ao contribuir com a definição do conector para o repositório open-source, seu conector personalizado fica disponível a outros usuários. Quando alguém usa um conector certificado, na verdade, a pessoa está usando uma definição que é corrigida automaticamente quando você publica atualizações. Quando você usar a definição de conector open-source, os usuários precisarão aplicar as atualizações nas cópias que tiverem. O restante deste módulo explica como você pode certificar seu conector personalizado e como gerenciar seu ciclo de vida à medida que o desenvolve.