Descrição geral dos conectores personalizados

Os Aplicativos Lógicos do Azure, o Microsoft Power Automate, o Microsoft Power Apps e o Microsoft Copilot Studio oferecem mais de 1.000 conectores para se conectar à Microsoft e serviços verificados, mas talvez você queira se comunicar com serviços que não estão disponíveis como conectores pré-criados. Os conectores personalizados abordam este cenário na medida em que lhe permitem criar (e até partilhar) um conector com acionadores e ações próprios.

Captura de tela mostrando como conectores personalizados fazem a ponte entre a API de Análise de Texto e os aplicativos.

Ciclo de vida

Captura de tela do ciclo de vida dos conectores personalizados em cinco estágios.

1. Compilar a sua API

Um conector personalizado é um wrapper em torno de uma API REST que permite ao Logic Apps, Power Automate, Power Apps ou Copilot Studio comunicar com essa API REST ou API SOAP. Estas APIs podem ser:

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

O Logic Apps também suporta APIs SOAP.

Para as APIs públicas que planeia criar e gerir, considere utilizar 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. Proteger a sua API

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

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

2.1. OAuth 2.0

Conectores personalizados que usam OAuth 2.0 para autenticação usam um URI de redirecionamento por conector. Se tiver conectores personalizados antigos criados antes de fevereiro de 2024 que usavam o URI global de redirecionamento, esses conectores foram atualizados ou deixaram de funcionar para novas ligações depois de o URI de redirecionamento por conector ter sido aplicado.

  • Se criou os seus conectores personalizados com a interface Web, edite os seus conectores personalizados, vá para o separador Segurança, selecione a caixa Atualizar para URL de redirecionamento exclusivo e, em seguida, guarde para ativar o URI de redirecionamento por conector.
  • Se você criou seus conectores personalizados com multi-auth usando a ferramenta de interface de linha de comando (CLI), você precisa atualizar seu conector usando a ferramenta CLI para definir "redirectMode": "GlobalPerConnector".
  • Assim que os conectores personalizados forem atualizados para utilizarem o URI de redirecionamento específico de cada conector, quer através da definição no separador Segurança quer através da ferramenta CLI, remova o URI de redirecionamento global das suas aplicações OAuth 2.0. Deve adicionar o endereço URL de redirecionamento único recentemente gerado às suas aplicações OAuth 2.0.
  • Para descobrir quais os conectores personalizados que precisam de ser atualizados para migrarem para o URL de redirecionamento por conector, pode criar um fluxo que utilize a ação Obter Conectores Personalizados como Administrador do conector Power Apps for Admin e analisar o resultado obtido. O fluxo apresentado mais à frente neste artigo obtém todos os conectores personalizados utilizando o mesmo método. Em seguida, aplica uma condição de filtro à propriedade do parâmetro de conexão para excluir os conectores personalizados não OAuth, seguida de outro filtro para selecionar apenas os conectores que não utilizam a URL de redirecionamento exclusiva de cada conector. Por fim, coloca os conectores personalizados selecionados numa variável de matriz inicializada no início do fluxo e gera uma tabela HTML que mostra o nome e o criador desses conectores. Você pode importar esse fluxo para seu ambiente importando esta solução. Pode expandir ainda mais o fluxo para enviar a tabela HTML como um e-mail para si mesmo. Ou pode expandi-lo para enviar e-mails diretamente aos criadores do conector e fornecer-lhes os nomes do conector que precisa de ser atualizado.

3. Descrever a API e definir o conector personalizado

Depois de ter uma API com acesso autenticado, a próxima coisa a fazer é descrever sua API para que os Aplicativos Lógicos, Power Automate, Power Apps, ou Copilot Studio possam se comunicar com sua API. São suportadas as seguintes abordagens:

As definições de OpenAPI e as coleções do Postman utilizam formatos diferentes, mas ambos são documentos legíveis por máquina e de linguagem desconhecida que descrevem a sua API. Pode gerar estes documentos a partir de várias ferramentas, com base na linguagem e plataforma que a API utiliza. Nos bastidores, Logic Apps, Power Automate, Power Apps e Copilot Studio utilizam o OpenAPI para definir conectores.

4. Utilize o seu conector no Copilot Studio, Logic Apps, Power Automate ou numa aplicação do Power Apps

Os conectores personalizados são usados da mesma forma que os conectores pré-construídos. Tem de criar uma ligação à sua API para poder utilizar essa ligação para chamar quaisquer operações que expõe no seu conector personalizado.

Os conectores criados em Power Automate estão disponíveis em Power Apps e Copilot Studio, e os conectores criados em Power Apps estão disponíveis em Power Automate e Copilot Studio. Essa disponibilidade não é verdadeira para conectores criados em Aplicativos Lógicos. No entanto, pode reutilizar a definição de OpenAPI ou a coleção do Postman para recriar o conector em qualquer um destes serviços. Para obter mais informações, consulte o tutorial adequado:

Sugestão

Se você atualizar (remover, adicionar ou alterar) um campo na API, execute estas etapas:

  1. Republique o conector para que passe a utilizar o Swagger atualizado da API.
  2. Remova qualquer conexão / fonte de dados em qualquer aplicativo que usou esse conector.
  3. Adicione novamente a conexão/fonte de dados desse conector de volta aos aplicativos.

5. Partilhe o seu conector

Pode partilhar o seu conector com utilizadores na sua organização da mesma forma como partilha recursos no Copilot Studio, no Logic Apps, no Power Automate ou no Power Apps. A partilha é opcional, mas pode ter cenários nos quais pretende partilhar os conectores com outros utilizadores.

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

6. Certificar o conector

Se quiser partilhar o seu conector com todos os utilizadores do Copilot Studio, Logic Apps, Power Automate e Power Apps, tem de submeter o seu conector à certificação da Microsoft. A Microsoft analisa o conector, verifica a conformidade técnica e de conteúdo e valida a funcionalidade.

Suporte de Rede Virtual

Quando o conector é utilizado num ambiente do Power Platform ligado a uma Rede Virtual, aplicam-se limitações:

  • Quando o código personalizado é usado, as limitações são explicadas em Escrever código em um conector personalizado.
  • Os conectores personalizados criados antes de o ambiente ser associado a uma Rede Virtual precisam ser salvos novamente.
  • Não são suportados acionadores que devolvem um cabeçalho de localização e que não fazem chamada de retorno para o conector personalizado.
  • Os pedidos OAuth e de token não transitam pela Rede Virtual associada. Só os pedidos para os pontos finais da API o fazem.

Enviar comentários

Apreciamos os comentários sobre problemas com a nossa plataforma de conectores ou novas ideias de funcionalidades. Para fornecer comentários, vá para Enviar problemas ou obter ajuda com conectores e selecione seu tipo de feedback.