Processo de certificação de editor verificado

  • Artigo

Este processo é para editores verificados (excluindo editores independentes). Se você for um editor independente, acesse Processo de certificação de editor independente.

Depois de concluir o desenvolvimento do conector personalizado, siga estas etapas a fim de prepará-lo para certificação e gerar os arquivos do conector a serem enviados à Microsoft.

Observação

Este tópico fornece informações para a certificação de conectores personalizados nos Aplicativos Lógicos do Azure, no Power Automate, e no Power Apps. Para seguir as etapas neste artigo, leia Certifique o conector e registre o conector personalizado na Microsoft.

Fluxo de trabalho básico do processo de certificação

O fluxograma a seguir mostra o fluxo de trabalho básico do processo de certificação. As etapas numeradas neste artigo correspondem ao fluxo de trabalho. Elas devem fornecer os detalhes necessários para concluir o processo de certificação.

Para uma visão expandida do fluxograma, selecione o ícone de lupa na parte inferior direita.

Fluxo de trabalho do processo de certificação de conector.

Para obter um visual detalhado deste fluxograma, vá para Fluxo de trabalho detalhado do processo de certificação de conectores.

Etapa 1: registrar seu conector

Você não precisa ter concluído o desenvolvimento no conector personalizado para solicitar a certificação. Para iniciar o processo de certificação, registre seu conector para certificação preenchendo nosso formulário de registro.

Aguarde um email dentro de dois dias úteis de um contato da Microsoft, que irá:

  • Entender um conector personalizado.
  • Aprender sobre seu progresso de desenvolvimento.
  • Orientá-lo através do processo de certificação.

Etapa 2: atender aos requisitos de envio

Para manter um alto padrão de qualidade e consistência entre nossos conectores certificados, a Microsoft possui um conjunto de requisitos e diretrizes que seu conector personalizado deve seguir para obter a certificação.

Dar um título ao seu conector

  • Deve existir e ser escrito em inglês.
  • Deve ser exclusivo e distinguível de qualquer título de conector existente.
  • Deve ser o nome do seu produto ou organização.
  • Deve seguir os padrões de nomenclatura existente para conectores certificados. Para editores independentes, o nome do conector deve seguir o padrão Nome do conector (Editor independente).
  • Não pode ter mais de 30 caracteres.
  • Não pode conter as palavras "API", "Conector" ou qualquer um de nossos nomes de produto do Power Platform (por exemplo, "Power Apps").
  • Não pode terminar com um caractere não alfanumérico, incluindo retorno de carro, nova linha ou espaço em branco.

Exemplos

  • Bons títulos de conectores: "Azure Sentinel", "Office 365 Outlook"
  • Títulos de conector ruins: "Conector Power Apps do Azure Sentinel","API do Office 365 Outlook"

Escreva uma descrição para o seu conector

  • Deve existir e ser escrito em inglês.
  • Deve estar livre de erros gramaticais e ortográficos.
  • Deve descrever de forma concisa o principal objetivo e o valor oferecidos pelo seu conector.
  • Não pode ter menos de 30 caracteres nem mais de 500 caracteres.
  • Não pode conter nenhum nome de produto do Power Platform (por exemplo, "Power Apps").

Criar um ícone para o conector

Essa seção não se aplica a editores independentes.

  • Crie um logotipo com dimensões 1:1 dentro de um intervalo de 100 x 100 a 230 × 230 pixels (sem bordas arredondadas).
  • Deve conter um plano de fundo não transparente e não branco (#ffffff) e uma cor não padrão (# 007ee5) que corresponda à cor de plano de fundo do ícone especificada.
  • Deve ser exclusivo para qualquer outro ícone de conector certificado.
  • Deve ser enviado em formato PNG como "ícone.png".
  • As dimensões do logotipo estão abaixo de 70% para a altura e a largura da imagem com plano de fundo consistente.
  • Certifique-se de que a cor da marca seja hexadecimal válida e não que não seja branca (#ffffff) ou padrão (#007ee5).

Definir resumos e descrições de operação e parâmetros

  • Deve existir e ser escrito em inglês.
  • Deve estar livre de erros gramaticais e ortográficos.
  • Os resumos de operação e parâmetro devem ser frases de 80 caracteres ou menos e só conter caracteres alfanuméricos ou parênteses.
  • Descrições de operação e parâmetro devem ser completas, descritivas e conter a pontuação final.
  • Não pode conter nenhum nome de produto do Microsoft Power Platform (por exemplo, "Power Apps").

Defina as respostas de operação exatas

  • Defina as respostas da operação com um esquema exato apenas com as respostas esperadas.
  • Não use respostas padrão com uma definição de esquema exata.
  • Fornece definições de esquema de resposta válidas para todas as operações no swagger.
  • Esquemas de resposta vazios não são permitidos, exceto em casos especiais em que o esquema de resposta é dinâmico. Isso significa que nenhum conteúdo dinâmico será mostrado na saída e os criadores devem usar JSON para analisar a resposta.
  • Operações vazias não são permitidas.
  • Remova as propriedades vazias, a menos que sejam necessárias.

Verificar as propriedades do swagger

  • Certifique-se de que "openapidefinition" esteja em um arquivo JSON formatado corretamente.
  • Certifique-se de que a definição do swagger esteja em conformidade com o padrão OpenAPI 2.0 e o padrão estendido dos conectores.

Verificar os parâmetros da conexão

  • Certifique-se de que a propriedade esteja atualizada com os valores apropriados para "UIDefinition" (nome de exibição, descrição).

  • Se o seu parâmetro de conexão usar autenticação Básica, certifique-se de que o JSON esteja formatado corretamente como no exemplo a seguir.

    {
  "username": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourUsernameLabel",
      "description": "The description of YourUsernameLabel for this api",
      "tooltip": "Provide the YourUsernameLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": true,
        "required": "true"
        }
  }
},
  "password": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourPasswordLabel",
      "description": "The description of YourPasswordLabel for this api",
      "tooltip": "Provide the YourPasswordLabel tooltip text",
      "constraints": {
        "tabIndex": 3,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • Se o seu parâmetro de conexão tiver a APIKey como autenticação, certifique-se de que o JSON esteja formatado corretamente como no exemplo a seguir.

    {
  "api_key": {
    "type": "securestring",
    "uiDefinition": {
      "displayName": "YourApiKeyParameterLabel",
      "tooltip": "Provide your YourApiKeyParameterLabel tooltip text",
      "constraints": {
        "tabIndex": 2,
        "clearText": false,
        "required": "true"
      }
    }
  }
}

  • Se o seu parâmetro de conexão tiver o OAuth Genérico como autenticação, certifique-se de que o JSON esteja formatado corretamente como no exemplo a seguir.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "oauth2",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "AuthorizationUrl": {
          "value": "https://contoso.com"
        },
        "TokenUrl": {
          "value": "https://contoso.com"
        },
        "RefreshUrl": {
          "value": "https://contoso.com"
        }
      },
      "clientId": "YourClientID"
    },
    "uiDefinition": null
  }
}

  • Se o seu parâmetro de conexão tiver um provedor de identidade OAuth2, certifique-se de que o provedor de identidade esteja na lista de provedores OAuth2 compatíveis. Veja a seguir o exemplo do provedor de identidade OAuth2 do GitHub:

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "github",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {},
      "clientId": "YourClientId"
    },
    "uiDefinition": null
  }
}

  • Se o seu parâmetro de conexão tiver o Microsoft Entra ID como autenticação, certifique-se de que o JSON esteja formatado corretamente como no exemplo a seguir.

    {
  "token": {
    "type": "oAuthSetting",
    "oAuthSettings": {
      "identityProvider": "aad",
      "scopes": [
        "scope1"
      ],
      "redirectMode": "GlobalPerConnector",
      "customParameters": {
        "LoginUri": {
          "value": "https://login.microsoftonline.com"
        },
        "TenantId": {
          "value": "common"
        },
        "ResourceUri": {
          "value": "resourceUri"
        },
        "EnableOnbehalfOfLogin": {
          "value": false
        }
      },
      "clientId": "AzureActiveDirectoryClientId"
    },
    "uiDefinition": null
  }
}

Crie cadeias de caracteres de qualidade em inglês

Os conectores são localizados como parte da localização do Power Automate. Assim, ao desenvolver um conector, a qualidade das cadeias de caracteres do idioma inglês é fundamental para a qualidade da tradução. Veja algumas das principais áreas para focar durante a criação de valores das cadeias de caracteres que você fornecer.

  • Execute um programa de verificação ortográfica para garantir que todos os valores da cadeia de caracteres não tenham erros tipográficos. Se houver alguma cadeia de caractere incompleta em inglês, o resultado da tradução ficará incompleto ou incorreto no contexto.

  • Certifique-se de que a frase esteja completa. Se a frase não estiver completa, isso também poderá gerar traduções de menor qualidade.

  • Verifique se o significado da frase está claro. Se o significado da frase for ambíguo, isso também poderá gerar menos qualidade ou traduções incorretas.

  • Certifique-se de que resumos, resumos x-ms e descrições estejam gramaticalmente corretos. Não os copie e cole. Para saber como eles são exibidos no produto, acesse Diretriz de cadeia de caracteres de conector.

  • Evite cadeias de caracteres compostas em runtime, se possível. Em vez disso, use frases totalmente formadas. Cadeias de caracteres ou frases concatenadas dificultam a tradução ou podem causar um erro na tradução.

  • Se você usar abreviações, captalize-as para deixar o significado claro. Isso reduzirá a chance de ser confundido com um erro tipográfico.

  • Cadeias de caracteres na forma CaMel (por exemplo, minimizeHighways ou MinimizeHighways) são normalmente consideradas não traduzíveis. Se quiser localizar o valor da cadeia de caractere, você deve corrigir a cadeia de caractere do formulário CaMel.

Etapa 3: usar o verificador de solução para validar seu conector

O verificador de solução é um mecanismo para realizar análises estáticas para garantir que seu conector esteja em conformidade com os padrões exigidos pela Microsoft para certificação. Adicione seu conector a uma solução no Power Automate ou no Power Apps e execute o verificador de solução seguindo as instruções em Validar um conector personalizado com o verificador de solução.

Assista a este vídeo para saber como executar o verificador de solução.

Etapa 4: adicionar metadados

Os artefatos (arquivos) do conector devem conter metadados específicos que descrevem o conector e seu serviço final. As informações fornecidas nos metadados serão publicadas na documentação do conector e poderão ser publicamente acessadas por todos os usuários. Não forneça nenhuma informação privada ou confidencial e nos avise por meio do seu contato da Microsoft caso haja algum problema para fornecer essas informações. Para saber como os metadados serão documentados, acesse qualquer uma das páginas de documentação específicas do conector em Referência do conector.

Etapa 4a: propriedades publisher e stackOwner

  • "editor" é o nome da sua empresa ou organização. Forneça o nome completo da empresa (por exemplo, "Contoso Corporation"). Isso deve estar no formato alfanumérico.

  • "stackOwner" é a empresa ou a organização proprietária da pilha de serviços back-end à qual o conector está se ligando. Isso deve estar no formato alfanumérico.

Editor Descrição Exemplo
Verificada O editor e o stackOwner serão os mesmos, a menos que o ISV esteja criando um conector em nome de um stackOwner. "editor": "Tesla",
"stackOwner": "Tesla"
Independente Você deve fornecer o proprietário da pilha e o proprietário do editor. "editor": "Nirmal Kumar",
"stackOwner": "ITGlue"

Local do arquivo: apiProperties.json
Para saber mais, vá para Arquivo de propriedades da API.

Sintaxe: As propriedades publisher e stackOwner existem como propriedades de nível superior dentro do arquivo apiProperties.json. Adicione as seguintes linhas destacadas como mostrado. Não se esqueça de inserir o nome da propriedade e o esquema exatamente conforme mostrado.

Captura de tela mostrando as propriedades publisher e stackOwner, disponíveis em trechos de código da amostra.

Etapa 4c: trechos de código de amostra

É possível usar os trechos de código a seguir para copiar e inserir as informações. Não se esqueça de adicionar os trechos aos arquivos corretos nos locais corretos, conforme descrito na seção anterior.

    "publisher": "_____",
    "stackOwner": "_____"

    "contact": {
      "name": "_____",
      "url": "_____",
      "email": "_____"
    }

    "x-ms-connector-metadata": [
      {
        "propertyName": "Website",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Privacy policy",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Categories",
        "propertyValue": "_____;_____"
      }
    ]

Observação

Existe uma limitação atual quanto ao uso da propriedade stackOwner e da ferramenta de CLI Paconn. Para obter mais informações, vá para Limitações no arquivo README.

Etapa 4d: formatação e limitações do arquivo JSON

  • Certifique-se de que suas propriedades estejam alinhadas corretamente.

  • Cole seu JSON no Visual Studio Code. Sinta-se à vontade para usar extensões como corretores ortográficos e plug-ins como plug-ins JSON.

  • Os arquivos swagger não devem ter mais de 1 MB.

    • Considere o design do seu conector antes de começar a criá-lo. Avalie se o conector deve ser dividido em dois (2) ou mais conectores.
    • Arquivos swagger maiores podem causar um atraso ao usar o conector.

    Por exemplo, existem três (3) conectores HubSpot diferentes na plataforma.

    Captura de tela de pastas para os três conectores do HubSpot.

Etapa 4e: validar seus arquivos de conector personalizados

Execute a paconn validate --api-def [Location of apiDefinition.swagger.json]. Essa ferramenta validará a definição de seu conector e informará sobre os erros que você deverá corrigir antes de enviar.

Caso o conector use OAuth como tipo de autenticação, adicione essas URLs de redirecionamento permitidas ao aplicativo:

  • https://global.consent.azure-apim.net/redirect/{apiname}

  • https://global-test.consent.azure-apim.net/redirect/{apiname}

Etapa 5: preparar os artefatos do conector

Esta etapa deve levar cerca de uma semana para ser concluída.

Observação

  • Verifique se você seguiu as especificações e garantiu a qualidade do seu conector antes da certificação. Não fazer isso resultará em atrasos na certificação porque será solicitado que você faça alterações.
  • Forneça uma versão de produção da URL do host. URLs de host de preparo, desenvolvimento e teste não são permitidos.

Você vai enviar para a Microsoft um conjunto de arquivos chamado artefatos do conector, baixado por meio de uma ferramenta CLI interface de linha de comandos fornecida pela Microsoft. Esta ferramenta validará seu conector quanto a erros de quebra.

Siga estas etapas para começar:

  1. Instale a ferramenta CLI Conectores do Microsoft Power Platform seguindo as instruções de instalação.

  2. Entre no Microsoft Power Platform usando a linha de comando executando paconn login. Siga as instruções para entrar usando o processo do código de dispositivo da Microsoft.

  3. Depois de fazer a autenticação, baixe os arquivos de conector personalizados:

    • Execute a paconn download. Selecione o ambiente em que seu conector personalizado está localizado especificando o número na linha de comando e, em seguida, selecione o nome do conector personalizado.

    A ferramenta baixará os artefatos do conector em uma pasta para o local do sistema de arquivos em que você executou paconn. Dependendo do tipo de editor, você encontrará vários artefatos:

Editor Artefato
Verificada apiDefinition.swagger.json
apiProperties.json
settings.json
Ícone do conector
Independente apiDefinition.swagger.json
apiProperties.json

Tanto os editores verificados quanto os independentes baixarão apiProperties.json em seus artefatos. Você precisa definir o IconBrandColor neste arquivo.

  • Editores verificados: defina iconBrandColor para a cor da sua marca no arquivo apiProperties.
  • Editores independentes: defina iconBrandColor como "#da3b01" no arquivo apiProperties.
    Captura de tela de um ícone laranja vívido (da3b01).

Criar um artefato de arquivo Readme

Um arquivo Readme.md é necessário para editores independentes e verificados. Você precisa criar um arquivo Readme.md para documentar os recursos e a funcionalidade do seu conector. Para obter um exemplo de documentação a ser incluído, vá para o exemplo de Readme.md. Veja outros arquivos Readme.md em nosso repositório GitHub para saber como escrever um arquivo Readme.md.

Se você for um editor independente e seu conector usar OAuth, certifique-se de incluir instruções sobre como obter credenciais.

Dica

Problemas e limitações conhecidos é uma ótima seção para manter seus usuários atualizados.

Etapa 6: envie seu conector para implantação

Durante o processo de envio, você abrirá o open-source do seu conector para nosso Repositório de conectores do Microsoft Power Platform.

  1. Siga as instruções em Enviar seu conector para certificação da Microsoft para enviar ao GitHub e ao portal de certificação.

    Se você for um editor verificado, será necessário enviar um arquivo script.csx se estiver usando código personalizado.

  2. Depois de enviar uma solicitação pull para o repositório de código aberto, a Microsoft implantará e validará seu conector dentro de 1 a 2 semanas. Se forem necessárias atualizações, aguarde mais 1 a 2 semanas.

    **Se o seu conector tiver OAuth, envie o pacote no ISV Studio e obtenha o nome da API na solicitação de envio do conector para atualizar seu aplicativo.

    Como parte do envio, a Microsoft validará seu conector usando as ferramentas bot do CLA, Validador de Swagger e Detector de Alteração Interruptiva. Se você precisar solucionar erros de swagger, vá para Corrigir erros do Validador Swagger.

Etapa 7: Expectativas de testes feitos por editores verificados

Depois de validarmos seu conector, solicitaremos que você execute um teste completo.

  1. Siga as instruções em Testar seu conector na certificação para criar um ambiente na região de visualização em preparação para o teste.

  2. Dentro de uma semana, notifique seu contato da Microsoft que você concluiu o teste para que possamos começar a implantação.

  3. Depois que a funcionalidade e o conteúdo do seu conector forem validados pela Microsoft e por você, prepararemos o conector para implantação na região de visualização para teste.

Etapa 8: aguardar Implantação

Depois do conector ser validado para teste, vamos implantá-lo em todos os produtos e regiões.

Importante

Em média, leva 3 a 4 dias úteis para implantar o conector. É obrigatório independentemente do tamanho ou complexidade do seu conector, seja ele novo ou uma atualização. Para proteger a integridade, o conector estará sujeito às mesmas tarefas de validação para testar a funcionalidade e o conteúdo que são seguidos em cada implantação.

Notificaremos você por email com os nomes das regiões nas quais o conector será implantado, pois a implantação nas regiões é feita em etapas. Se houver um atraso ou congelamento da implantação, os editores verificados podem encontrar o status no Controle de Atividades no Portal ISV. Editores independentes serão notificados por email.

Implantação de produção

Nossas agendas de implantação de conector para produção começam nas manhãs de sexta-feira, PST/PDT. Será necessário informar ao seu contato da Microsoft quando estiver pronto para a implantação em produção com pelo menos 24 horas de antecedência para incluirmos seu conector na próxima implantação agendada. Editores verificados podem nos notificar no Controle de Atividades do Portal ISV. Os editores independentes podem notificar seu contato da Microsoft.

Implantação da região

A implantação em várias regiões ocorre em uma sequência diária predeterminada. As regiões são:

  • Teste.
  • Versão preliminar EUA.
  • Ásia, exceto Japão e Índia.
  • Europa, exceto Reino Unido.
  • Brasil, Canadá, Japão e Índia.
  • Austrália, Reino Unido e EUA.

Por exemplo, se o seu conector estiver agendado para ser implantado na segunda-feira, ele será implantado na região de teste no dia 1. Em seguida, ele será implantado na região de versão preliminar dos EUA no dia 2. A implantação continuará diariamente até que o conector seja implantado em todas as seis regiões.

Não implantamos aos sábados, domingos e feriados nos EUA.

Quando seu conector estiver concluindo a certificação, falaremos com você sobre uma oportunidade de marketing para o conector no blog do Power Automate.

Etapa 9: explorar as opções pós-implantação

Aqui estão algumas opções que será possível explorar depois que o conector for implantado:

Lista de verificação antes de enviar

Antes de passar para Enviar seu conector para certificação da Microsoft, certifique-se de que:

Dica

  • Crie vídeos, blogs ou outros conteúdos do YouTube para compartilhar amostras ou capturas de tela sobre como começar a usar o conector.
    - Inclua os links no arquivo Readme.md para que possamos adicionar aos nossos documentos.
  • Adicione dicas de ferramentas ao seu arquivo swagger para ajudar seus usuários a serem mais bem-sucedidos.

Se você for um editor verificado (e não um editor independente), será solicitado que você concorde com nosso contrato de parceria e contrato de confidencialidade ao enviar para a certificação da Microsoft. Se você quiser tirar dúvidas sobre estes termos e linguagem antes do envio, converse com seu contato da Microsoft.

Próxima etapa

Enviar seu conector para certificação da Microsoft

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.