Certificar um conector personalizado

Concluído

Para disponibilizar um conector personalizado para todos os usuários nos Aplicativos Lógicos, no Power Automate e no Power Apps como um conector certificado, envie seu conector à Microsoft para certificação. A Microsoft analisará o conector e, se ele atender aos critérios de certificação, o aprovará para publicação. Depois que o conector for publicado, ele ingressará na lista completa de conectores disponíveis publicamente.

Esta unidade examina cada etapa do processo de certificação, inclusive algumas etapas de alto nível. Essas mesmas etapas também se aplicam a atualizações posteriores, mas, dependendo do escopo da atualização, elas podem ser consideravelmente mais rápidas.

Diagrama do processo de certificação com etapas de planejamento, desenvolvimento, criação de software livre, envio, certificação, teste, implantação e suporte.

Planejamento

O planejamento é a primeira etapa no processo de certificação, à medida que você começa a imaginar a aparência que o conector terá. A criação de um conector que outras pessoas usarão deve envolver algum planejamento.

A primeira etapa é verificar se já existe um conector. Se existir, considere contribuir com as alterações propostas para o conector existente, pois a Microsoft não certificará vários conectores para a mesma API.

Alguns dos principais fatores de planejamento que devem ser considerados são:

  • Identifique quais gatilhos e ações estarão disponíveis inicialmente. Você não precisa de 100% de sua API coberta, mas o conjunto inicial de gatilhos e ações deve ser um conjunto útil. Se você limitar demais o que há na versão inicial, os usuários ficarão frustrados com a falta de funcionalidade para cenários comuns. Considere escrever ou esboçar um ou mais fluxos de trabalho que podem ser criados no Microsoft Power Automate usando seu conector. Essa abordagem pode ajudá-lo a decidir quais APIs incluir no conector.

  • Avalie quais alterações podem ser necessárias na API para dar suporte a gatilhos ou melhorar a capacidade de fornecer um conector amigável.

  • Considere como a autenticação será tratada e qual é a adaptação necessária entre a maneira como sua API é autenticada atualmente e os recursos com suporte de conectores personalizados.

  • Considere como os usuários que desejam usar o conector obterão uma chave, se a API usar chaves de API.

  • Examine os modelos de política do conector para determinar se a implementação de modelos ajudaria na usabilidade de seu conector.

  • Examine as extensões de OpenAPI com suporte para aplicabilidade. Por exemplo, a conexão de teste é comumente implementada por conectores certificados. Além disso, o uso de extensões de valor dinâmico poderá ser útil se você tiver parâmetros com listas de valores dentre os quais escolher.

Para obter a certificação de um novo conector, você não precisa esperar até terminar de desenvolvê-lo para se registrar para a certificação. Para obter mais informações, consulte o Processo de Certificação de Editor Verificado ou o Processo de Certificação de Editores Independentes. Espere receber uma comunicação de um representante da Microsoft, que o ajudará a entender melhor seu conector personalizado, explicará o progresso de desenvolvimento e orientará você no processo de certificação.

Para atualizações de um conector certificado, a parte mais importante do planejamento é não afetar os usuários existentes. Esse problema será discutido com mais detalhes em uma unidade posterior.

Desenvolvimento

O foco principal na etapa de desenvolvimento é preparar a API e a definição do conector personalizado para envio. Antes de prosseguir para a próxima etapa, você deve garantir que a definição do conector personalizado esteja limpa e tenha toda a nomenclatura adequada que você deseja publicar.

Criar um software livre

A unidade de introdução abordou uma visão geral de alto nível de como criar um conector de software livre. Você colocará o conector certificado do editor verificado na pasta certified-connectors e os conectores do editor independente na pasta independent-publisher-connectors. Antes de enviar uma solicitação de pull, realize as seguintes tarefas:

  • Edite os arquivos do conector para adicionar os metadados específicos necessários. Os arquivos do conector devem conter metadados específicos que descrevam o conector e seu serviço final.

  • Execute o comando paconn validate no conector baixado e resolva os erros.

Para executar a validação, use o seguinte comando:

paconn validate --api-def [Location of apiDefinition.swagger.json]

Depois de ser aprovado na validação, você pode enviar sua solicitação de pull para a ramificação dev do repositório GitHub. Esta ação iniciará um processo automatizado que conduzirá a validação inicial de sua solicitação de pull e garantirá que você tenha um contrato de contribuição adequado em vigor. Quando a validação automatizada for concluída, ela será atribuída à Microsoft para análise inicial. Se os revisores encontrarem problemas que precisem ser corrigidos, inserirão comentários na solicitação de pull e você deverá resolvê-los e reenviar a solicitação de pull. Quando tudo parecer aceitável, sua solicitação de pull será mesclada no repositório.

Envio de Editor Independente

Se você estiver publicando um conector de editor independente, a próxima etapa será enviar os artefatos do conector para a solicitação de pull que você criou ao propor o conector, preencher a lista de verificação no modelo de solicitação de pull e remover "Proposta -" do título da solicitação de pull. Um engenheiro de certificação da Microsoft fornecerá comentários dentro de 1 a 2 semanas após sua solicitação inicial. Se os comentários exigirem uma atualização do conector, você precisará enviar uma atualização para a solicitação de pull. Depois que você

Envio de Editor Verificado

A próxima etapa é enviar seu conector para certificação no ISV Studio depois que você for solicitado a fazê-lo por seu contato da Microsoft. O ISV Studio é um portal para gerenciar o restante do processo de certificação e fornecer a você a integridade do conector depois que ele for implantado.

Como parte do processo de envio ao ISV Studio para certificação, você deve estar preparado para fornecer:

  • Informações de teste do conector, por exemplo, uma chave de API, outros detalhes de autenticação ou quaisquer detalhes que ajudem um testador a usar o conector.

  • Um arquivo Intro.md que contém informações a serem incluídas na documentação pública do conector. Você pode encontrar um modelo na documentação de Envio ao ISV Studio.

À medida que a certificação avançar, você obterá atualizações no portal e receberá um email do contato principal. Caso sejam encontrados problemas, espera-se que você os resolva antes de prosseguir com a certificação. Depois que o conector for aprovado na certificação, ele será agendado para implantação na região de "Versão preliminar" para teste.

Testes

Como parte do processo de certificação, o conector é implantado na região de "Versão preliminar" para testes. Agora é sua oportunidade de garantir que o conector implantado funcione corretamente antes de ser implantado em todas as regiões do mundo. Teste todas as funcionalidades do conector no Power Apps, no Power Automate e nos Aplicativos Lógicos.

Para obter mais informações, consulte Instruções sobre como testar seu conector na certificação.

Implantação

Após a conclusão dos testes, o conector será implantado em todas as regiões públicas. Espera-se que esse processo leve de sete a 10 dias úteis, pois a Microsoft implanta de forma incremental em suas regiões em todo o mundo. Você receberá notificações à medida que cada região for implantada.

Suporte

Agora que seu conector foi lançado publicamente, para conectores de editores verificados, você pode monitorar seu desempenho no ISV Studio. Verifique se sua equipe de suporte está ciente de como o conector pode ser usado com o Power Apps ou o Power Automate para que possa dar suporte a usuários que enfrentarem problemas.