Exercício: criar um conector personalizado certificado

  • 6 minutos

Neste exercício, você usará a CLI paconn para baixar um conector, validar a definição e resolver problemas. Esse exercício simula o que você deve fazer para preparar a criação e a certificação de um conector personalizado de software livre.

Este exercício requer a instalação do Python e o acesso ao prompt de comando no computador usado para o exercício.

Importante

Use um ambiente de teste com o Microsoft Dataverse provisionado. Se você não tiver um, poderá se inscrever no plano da comunidade.

Observação

Baixe o arquivo a seguir no computador local para fazer este exercício: Contoso Invoicing Triggers. Selecione o botão de download na parte central direita da tela.

Importar a solução

Nesta tarefa, você importará uma solução não gerenciada que contém um conector personalizado da Contoso Invoicing. Você usa esse conector para concluir as tarefas deste exercício.

  1. Acesse o Power Apps maker portal e verifique se você está no ambiente correto.

  2. Selecione Soluções > Importar solução.

  3. Selecione Procurar.

  4. Selecione a solução ContosoInvoicingOpenSource_1_0_0_0.zip e, em seguida, clique em Abrir.

  5. Selecione Avançar.

  6. Selecione Importar e aguarde a conclusão da importação. Uma mensagem de êxito deve aparecer após a conclusão da importação.

  7. Abra a solução Contoso Invoicing - Open Source que você importou.

O componente de conector personalizado Contoso Invoicing - Open Source deve ser exibido.

Instale a CLI de Conectores do Microsoft Power Platform

A CLI de Conectores do Microsoft Power Platform inclui a ferramenta de linha de comando paconn projetada para ajudar no desenvolvimento de conectores personalizados do Microsoft Power Platform. A ferramenta paconn usa o tempo de execução do Python, que também será instalado.

  1. Vá para Baixar o Python e selecione o botão Baixar o Python. Você pode usar qualquer versão superior a 3.5.

  2. Selecione o arquivo .exe baixado para iniciar a instalação.

  3. Marque a caixa de seleção Adicionar Python xx ao Caminho, selecione Instalar Agora e aguarde a conclusão da instalação.

  4. Feche o assistente de instalação após a conclusão da instalação.

  5. Inicie o prompt de comando e execute o seguinte comando para instalar o paconn.

    pip install paconn

  6. Aguarde a conclusão da instalação.

Baixar o conector localmente

Nesta tarefa, você baixará os arquivos de definição de conector localmente para adicionar a propriedade URL do Host.

  1. Execute o comando paconn login.

  2. Copie o Código fornecido.

  3. Em um navegador, faça login com as mesmas credenciais do seu ambiente. Vá para Entrar no dispositivo Microsoft, cole o Código copiado e, em seguida, selecione Avançar.

  4. Forneça as credenciais.

  5. Selecione Continuar.

    Uma mensagem de entrada com êxito deve aparecer.

  6. Retorne ao prompt de comando, em que uma mensagem de logon bem-sucedido é exibida.

  7. Execute o comando de download.

    paconn download

  8. Quando solicitado a selecionar um ambiente, digite um número para o ambiente em que você instalou a solução. Pressione a tecla Enter no teclado.

  9. Forneça o número do conector Contoso Invoicing - Open Source e pressione a tecla Enter no teclado.

  10. O download deve ser concluído com êxito. Observe o local em que o conector foi baixado.

Validar o conector, corrigir erros e adicionar metadados

Nesta tarefa, você validará o conector, corrigirá alguns erros comuns e adicionará os metadados necessários do conector.

  1. Copie o caminho em que o conector foi baixado.

  2. Execute o comando validar usando o caminho copiado e o nome do arquivo Swagger da definição da API \apiDefinition.swagger.json.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

    Deve surgir um erro para um resumo ausente para o quarto parâmetro da ação ListInvoices e uma propriedade de contato ausente.

  3. Corrija o resumo ausente. Acesse o Power Apps maker portal e verifique se você está no ambiente correto.

  4. Selecione Soluções e abra a solução Contoso Invoicing - Open Source.

  5. Selecione o conector Contoso Invoicing - Open Source e selecione Editar.

  6. Selecione a guia Definição e selecione a ação ListInvoices.

  7. Role até a seção Solicitação, selecione o botão reticências (Divisa) do parâmetro toAmount e, em seguida, selecione Editar.

  8. Insira To amount no campo Resumo e selecione Atualizar conector.

  9. Aguarde a conclusão da atualização do conector.

  10. Exclua o conector baixado anteriormente (você o adicionará novamente em alguns instantes). Exclua do seu computador o conector baixado.

  11. Baixe o conector novamente. Retorne ao prompt de comando e execute o comando de download novamente.

    paconn download

  12. Quando solicitado a selecionar um ambiente, digite o número do ambiente em que você instalou a solução. Pressione a tecla Enter no teclado.

  13. Forneça o número do conector Contoso Invoicing - Open Source e pressione a tecla Enter no teclado.

  14. O download deve ser concluído com êxito. Observe o local em que o conector foi baixado.

  15. Execute o comando validar usando o caminho copiado e o nome do arquivo Swagger da definição da API \apiDefinition.swagger.json.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

    Agora, você deve receber apenas um erro para o parâmetro de contato ausente.

  16. Vá para a pasta conector que você baixou e abra o arquivo apiDefinition.swagger.json usando o editor de texto de sua escolha, como o Bloco de Notas.

  17. Adicione uma propriedade de contato às informações após a propriedade descrição.

    "contact": {
  "name": "Contoso Support",
  "url": "https://contosoinvoicingtest.azurewebsites.net",
  "email": "info@Contoso.com"
}

  18. Adicione os metadados do conector após as informações.

    "x-ms-connector-metadata": [
  {
   "propertyName": "Website",
   "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
  },
  {
   "propertyName": "Privacy policy",
   "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
  },
  {
   "propertyName": "Categories",
   "propertyValue": "Productivity"
  }
],

  19. Selecione Arquivo e Salve as alterações.

  20. Execute o comando validar mais uma vez.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

Agora, o conector deve ser validado com êxito.

Você preparou com êxito o conector a ser criado como software livre e, em seguida, certificado. Ao criar um conector real, você publicaria o conector no GitHub.