Conectores personalizados

Embora os Aplicativos Lógicos do Azure, o Microsoft Power Automate e o Microsoft Power Apps ofereçam mais de 1.000 conectores para conexão com serviços da Microsoft e serviços verificados, talvez você queira se comunicar com serviços que não estejam disponíveis como conectores predefinidos. Os conectores personalizados lidam com esse cenário permitindo a criação (e até mesmo o compartilhamento) de um conector com seus próprios gatilhos e ações.

Screenshot of custom connectors - overview.

Ciclo de vida

Screenshot of custom connectors - lifecycle.

1. Crie sua API

Um conector personalizado é um wrapper em torno de uma API REST que permite que os Aplicativos Lógicos, o Power Automate ou o Power Apps se comuniquem com a API REST ou a API SOAP. Essas APIs podem ser:

  • Público (visível na Internet pública), como Spotify, Slack, Rackspace ou uma API que você gerencia.
  • Privado (visível apenas para sua rede).

Os Aplicativos Lógicos também oferecem suporte às APIs SOAP.

Para APIs públicas que você planeja criar e gerenciar, considere usar um destes produtos do Microsoft Azure:

Para APIs privadas, a Microsoft oferece conectividade de dados local por meio de um gateway de dados local.

2. Proteja sua API

Use um destes métodos de autenticação padrão para suas APIs e conectores (Microsoft Entra ID é recomendado):

Você pode configurar a autenticação do Microsoft Entra ID para sua API no portal do Azure para que você não precise implementar a autenticação. Ou você pode exigir e impor autenticação no código da API. Para obter mais informações sobre o Microsoft Entra ID para conectores personalizados, consulte Proteger sua API e o conector com o Microsoft Entra ID.

2.1. OAuth 2.0

Os conectores personalizados recém-criados que usam o OAuth 2.0 para se autenticar automaticamente têm um URI de redirecionamento por conector. Os conectores OAuth 2.0 existentes devem ser atualizados para usar um URI de redirecionamento por conector até 17 de fevereiro de 2024.

  • Se você tiver criado os conectores personalizados com a interface da Web, edite os conectores personalizados, vá até a guia Segurança e marque a caixa Atualizar para URL de redirecionamento exclusiva e salve para habilitar o URI de redirecionamento por conector.
  • Se tiver criado os conectores personalizados com multi-auth usando a ferramenta de interface de linha de comando (CLI), você precisará atualizar o conector usando a ferramenta CLI para definir "redirectMode": "GlobalPerConnector".
  • Depois que os conectores personalizados forem atualizados para usar o URI de redirecionamento por conector por meio da configuração na guia Segurança ou usando a ferramenta CLI, você deverá remover o URI de redirecionamento global dos aplicativos OAuth 2.0. Você deve adicionar a URL de redirecionamento exclusiva recém-gerada aos seus aplicativos OAuth 2.0.
  • Vamos aplicar essa atualização para conectores personalizados OAuth 2.0 existentes a partir de 17 de fevereiro de 2024. Qualquer conector personalizado que não tiver sido atualizado para usar um URI de redirecionamento por conector deixará de funcionar para novas conexões e exibirá uma mensagem de erro ao usuário.
  • Para descobrir quais conectores personalizados precisam de uma atualização a ser migrada por URL de redirecionamento de conector, você pode criar um fluxo simples que usa a ação Obter Conectores Personalizados como Administrador do conector do Power Apps para Administrador e analisar o resultado. O fluxo anexado posteriormente neste artigo busca todos os conectores personalizados usando o mesmo. Em seguida, ele aplica uma condição de filtro na propriedade do parâmetro de conexão para filtrar um conector personalizado não Oauth, seguido de outro filtro para só selecionar conectores que não usam a URL de redirecionamento exclusivo por conector. Por fim, ele coloca os conectores personalizados selecionados em uma variável de matriz inicializada no início do fluxo e gera uma tabela HTML mostrando o nome e o criador desses conectores. Você pode importar esse fluxo para seu ambiente importando essa solução. Você pode estender ainda mais o fluxo para enviar a tabela HTML como um email para você mesmo. ou você pode estendê-lo para enviar emails diretamente aos criadores do conector e fornecer a eles os nomes dos conectores que precisam ser atualizados.

3. Descreva a API e defina o conector personalizado

Depois de ter uma API com acesso autenticado, a próxima etapa será descrever sua API para que os Aplicativos Lógicos, o Power Automate ou o Power Apps possa se comunicar com sua API. As seguintes abordagens têm suporte:

Definições OpenAPI e coleções Postman usam formatos diferentes, mas ambos são documentos legíveis por computador independente de linguagem que descrevem sua API. Você pode gerar esses documentos por meio de várias ferramentas, com base na linguagem e plataforma usadas pela sua API. Nos bastidores, Aplicativos Lógicos, o Power Automate e o Power Apps usam OpenAPI para definir conectores.

4. Use seu conector em um Aplicativo Lógico, aplicativo do Power Automate ou do Power Apps

Os conectores personalizados são usados da mesma forma que os conectores predefinidos. Você deverá criar uma conexão com sua API para usar essa conexão para chamar qualquer operação exposta no seu conector personalizado.

Os conectores criados no Power Automate estão disponíveis no Power Apps. Da mesma forma, os conectores criados no Power Apps estão disponíveis no Power Automate. Isso não ocorre para conectores criados em aplicativos lógicos. No entanto, você pode reutilizar a definição OpenAPI ou coleção Postman para recriar o conector em qualquer um desses serviços. Para obter mais informações, consulte o tutorial adequado:

5. Compartilhe seu conector

Você pode compartilhar seu conector com usuários em sua organização da mesma forma que compartilha recursos em Aplicativos Lógicos, Power Automate, ou Power Apps. O compartilhamento é opcional, mas talvez você tenha cenários em que queira compartilhar seus conectores com outros usuários.

Saiba mais em Compartilhar conectores personalizados em sua organização.

6. Certifique seu conector

Se quiser compartilhar seu conector com todos os usuários dos Aplicativos Lógicos, do Power Automate e do Power Apps, você poderá enviá-lo para certificação da Microsoft. A Microsoft examinará o conector, verificará a conformidade técnica e de conteúdo, e validará a funcionalidade.

Para obter mais informações, consulte Enviar seus conectores para certificação da Microsoft.

Tutorial

O tutorial usa a API de Análise de Texto dos Serviços Cognitivos. A Microsoft já fornece um conector para esta API. É um bom exemplo para ensinar o ciclo de vida do conector personalizado e como os conectores personalizados podem oferecer suporte a cenários exclusivos.

Cenário

O conector criado exibe a operação Sentimento da Análise de Texto, que retorna a pontuação de sentimento (0,000 a 1,000) para a entrada de texto.

Pré-requisitos

  • Uma das assinaturas a seguir:

  • Noções básicas de como criar Aplicativos Lógicos, fluxos do Power Automate ou Power Apps.

  • Chave de API para a API de Análise de Texto dos Serviços Cognitivos.

Obter uma chave de API

A API de Análise de Texto usa uma chave de API para autenticar usuários. Quando um usuário cria uma conexão com a API por meio de um conector personalizado, ele especifica o valor dessa chave. Para obter uma chave de API:

Iniciar o tutorial

Orientações avançadas

Os tutoriais e o vídeo nesta seção fornecem os insights necessários para utilizar conectores do Power Platform como parte de suas implementações.

Tutoriais

Os tutoriais a seguir fornecem mais detalhes para cenários específicos de conectores personalizados:

Vídeo

O vídeo de 45 minutos a seguir mostra como os conectores do Power Platform funcionam. Ele também demonstra como criar conectores personalizados simples e avançados.

Suporte à Rede Virtual

Quando o conector é usado em um ambiente do Power Platform vinculado a uma rede virtual, limitações se aplicam:

  • Quando o código personalizado é usado: as limitações são explicadas em Escrever código em um conector personalizado.

  • Os conectores personalizados que foram criados antes do ambiente ser associado a uma rede virtual devem ser salvos novamente.

Enviar comentários

Agradecemos muito os comentários sobre problemas com nossa plataforma de conectores ou novas ideias de recursos. Para fornecer comentários, acesseEnviar problemas ou obter ajuda com conectores e selecione o tipo de comentário.