Introdução

Concluído

Este módulo fala sobre os conectores personalizados e explica como configurá-los e usá-los com o Microsoft Power Apps, Microsoft Power Automate e os Aplicativos Lógicos do Microsoft Azure.

Neste módulo, você vai:

  • Aprender sobre a função dos conectores personalizados.

  • Criar um conector e usá-lo em um fluxo do Power Automate.

Com os conectores, fica mais fácil para criadores de aplicativos e fluxos se conectarem a outros aplicativos, dados e dispositivos na nuvem das seguintes maneiras:

  • A conexão é realizada de forma consistente e repetitiva, sendo detectável pelos criadores.

  • Os conectores têm ações que permitem que os criadores controlem quando uma operação é realizada.

  • Os conectores podem ter gatilhos que permitem o início da automação quando o evento de disparo ocorre.

Diagrama com API no centro, ao lado do conector e do Power Automate, Power Apps e Aplicativos Lógicos.

Um conector é um proxy ou wrapper em torno de uma API que permite que o Power Automate, o Power Apps e os Aplicativos Lógicos se comuniquem com o serviço subjacente. Muitos conectores são predefinidos e estão disponíveis para uso sem que seja preciso definir algo. Essas definições de conector integrado incluem serviços da Microsoft e de outras organizações. Quando o serviço ou a API que você deseja usar não tem um conector pré-integrado, você pode criar seu próprio conector personalizado. Se um conector predefinido não expor todos os gatilhos e as ações necessárias da API, você pode criar um conector personalizado além do disponível para lidar com esses requisitos adicionais. Depois de ser definido, o conector personalizado fica disponível para uso quando você cria aplicativos e fluxos nesse ambiente, de modo semelhante aos conectores integrados.

O processo de alto nível é Identificar ou construir API, Descrever API, Usar conector e Certificar software livre.

Identificar ou construir a API

A primeira tarefa é verificar a referência do conector para determinar se já existe um conector adequado para a API/serviço. Se ainda não houver um conector adequado, você poderá criar seu próprio conector personalizado. Você pode definir o conector personalizado para descrever qualquer API REST que seja pública (disponível na Internet) ou privada (disponível apenas na sua rede interna). As APIs particulares exigem que o gateway de dados local acesse os recursos internos.

Se uma API compatível ainda não existir, os desenvolvedores poderão criar uma API usando a tecnologia de sua preferência que seja capaz de hospedar uma API REST, incluindo Microsoft Azure Functions e Serviços de Aplicativo do Azure. Você também pode usar o Gerenciamento de API do Azure para aumentar a capacidade de gerenciamento e a governança das APIs.

Descreva a API

Para que o Power Apps e o Power Automate consigam descobrir quais gatilhos e ações estão disponíveis na API, você deve identificá-los ao criar o conector personalizado. Você pode realizar essa tarefa editando manualmente a definição do conector no maker portal ou importando uma definição em um formato compatível. Esse processo inclui a identificação dos requisitos de autenticação para a API.

Usar o conector

Depois de terem sido criados em um ambiente, os conectores personalizados podem ser usados da mesma forma que os conectores integrados. Esses conectores também podem ser usados em um ambiente diferente daquele usado para criá-los. A definição de conector deve ser exportada do ambiente em que foi criada e depois importada para qualquer ambiente que necessite dela. Você também pode compartilhar o conector com outras pessoas e permitir que elas o usem, como outros recursos compartilhados.

Certifique e compartilhe o conector como um software livre

Como os conectores personalizados estão disponíveis apenas em ambientes nos quais sua definição existe, eles não estarão disponíveis para outros clientes da Microsoft. Ao compartilhar uma definição de conector personalizada como um software livre, você a disponibiliza no GitHub para que outros clientes a importem para seus respectivos ambientes. Ao certificar seu conector personalizado, você também pode disponibilizá-lo como um conector pré-integrado em todos os ambientes de clientes. Para certificar um conector, você precisa ser o proprietário da API ou ter a permissão explícita do proprietário da API para publicar um conector.

Para obter mais informações, consulte o Processo de certificação.

Esta etapa do processo é opcional e só será necessária se você quiser compartilhar seu conector, que já deve estar listado como certificado. Os conectores voltados ao uso interno não precisam realizar este processo de certificação.

Descreva o conector

Para definir as ações e os gatilhos de um conector, você precisa descrevê-lo. Um conector personalizado pode ser definido ao se descrever apenas as ações e os gatilhos da API necessários. Por exemplo, se uma API tiver 100 ações e 10 gatilhos disponíveis, você conseguiria um conector personalizado com uma única ação. Você também pode descrever mais tarde, conforme suas necessidades mudam.

Ao descrever a API, você usará pelo menos uma das abordagens a seguir. Se você optar por importar uma definição de OpenAPI ou uma coleção de Postman, ainda assim será possível manipular manualmente a definição do seu conector no portal.

  • Criar manualmente no portal – com essa abordagem, você usaria a documentação da API e exemplos de entradas e saídas e, em seguida, definiria cada ação e gatilho. Essa abordagem é boa para APIs simples, nas quais você não consegue importar a definição. Você também pode usar esta abordagem para refinar as definições depois de importá-las.

  • Importar a definição de OpenAPI - OpenAPI é uma especificação que descreve REST, simplificando as tarefas de desenvolvimento e consumo de uma API, mapeando todos os recursos e operações associados a ela. Vários serviços/APIs publicam uma definição de OpenAPI, e você pode importá-la para descrever a API no conector personalizado. É possível fazer a importação da versão 2.0; a versão 3.0 não tem suporte no momento. Essa abordagem será útil se uma definição de OpenAPI estiver disponível no editor da AP. Se estiver desenvolvendo a API, você poderá publicá-la.

  • Importar coleção Postman - Postman é uma ferramenta para testar APIs REST. Você pode usar essa ferramenta para executar as ações na API que deseja descrever e salvá-las como uma coleção da Postman. Essa coleção é importada para descrever a API no conector personalizado. Atualmente, é possível usar essa abordagem com coleções v1, V2.0 ou V2.1.

  • Importar do GitHub: importar conectores do Repositório de conectores do Power Platform. Essa é a melhor abordagem quando já existe um conector publicado no repositório e você deseja importá-lo para modificá-lo ou usá-lo como um conector personalizado.

  • Exportar do Azure – se sua API foi criada como um Serviço de Aplicativo do Azure, como Microsoft Azure Functions ou se for gerenciada pelo Gerenciamento de API do Microsoft Azure, você pode exportar esses serviços, o que criará automaticamente a definição de conector personalizado inicial.

Trabalhar com APIs autenticadas

A arquitetura de conectores personalizados consegue trabalhar com APIs autenticadas. Ao definir o conector personalizado, você identificará como ele deve ser autenticado na API. As opções de autenticação são compatíveis com acesso anônimo, protegido por senha, OAuth 2.0 e chave de API.

  • Sem autenticação: essa opção é para APIs que permitem acesso anônimo, sendo o padrão se você não configurar um tipo específico de autenticação.

  • Autenticação Básica – essa opção é para APIs que exigem um usuário e senha para serem enviadas com cada solicitação.

  • O OAuth 2.0 - OAuth 2.0 é o protocolo padrão do setor para autorização. Esta opção pode ser configurada para qualquer API que usa o OAuth 2.0. As configurações pré-integradas estão disponíveis para serviços da Microsoft, como o Microsoft Entra ID, o GitHub e o Azure DevOps. Há configurações pré-integradas semelhantes disponíveis para outros serviços como o Dropbox, Slack, Stripe, entre outros. As configurações pré-integradas simplificam o que você precisa fornecer para configurar o provedor de identidade.

  • Chave de API – é um token que um cliente fornece ao fazer chamadas à API. O editor da API normalmente fornece a chave, que deve ser incluída em cada solicitação do conector personalizado.

Com os conectores personalizados, os criadores de aplicativos e de fluxos conseguem usar as APIs e os serviços mais facilmente. Na maioria dos casos, os criadores poderiam invocar diretamente a API sem um conector; no entanto, eles teriam que saber como compor a solicitação e interpretar os resultados e, depois, trabalhar com a autenticação. Esse processo teria que ser feito toda vez que o aplicativo ou fluxo usasse conectores personalizados.

Além disso, nem sempre é fácil para um criador ter conectores personalizados que incluam gatilhos que permitem a inicialização dos fluxos por eventos. Os conectores personalizados ajudam você a descobrir com mais facilidade como usar ações e ver os resultados ao desenvolver um aplicativo ou fluxo que usa o conector.

A próxima seção fala sobre como desenvolver um conector personalizado.