Processus de certification d’éditeurs vérifiés

  • Article

Ce processus est pour les éditeurs vérifiés (hors éditeurs indépendants). Si vous êtes un éditeur indépendant, rendez-vous sur Processus de certification des éditeurs indépendants.

Après avoir terminé le développement de votre connecteur personnalisé, suivez ces étapes pour le préparer à la certification et générer les fichiers de connecteur à envoyer à Microsoft.

Notes

Cette rubrique offre des informations pour la certification des connecteurs personnalisés dans Azure Logic Apps, Power Automate et Power Apps. Avant de suivre les étapes présentées dans cet article, consultez Obtenir la certification de vos connecteurs et enregistrer votre connecteur personnalisé avec Microsoft.

Flux de travail de base du processus de certification

L’organigramme suivant présente le flux de travail du processus de certification de base. Les étapes numérotées de cet article correspondent au flux de travail. Ils doivent fournir les détails dont vous avez besoin pour terminer le processus de certification.

Pour une vue développée de l’organigramme, sélectionnez l’icône en forme de loupe en bas à droite.

Flux de travail approfondi du processus de certification des connecteurs.

Pour un visuel détaillé de cet organigramme, rendez-vous sur Flux de travail approfondi du processus de certification des connecteurs.

Étape 1 : Enregistrer votre connecteur

Vous n’avez pas besoin d’avoir terminé le développement de votre connecteur personnalisé pour demander la certification. Pour commencer le processus de certification, enregistrez votre connecteur pour la certification en remplissant notre formulaire d’inscription.

Attendez-vous à recevoir un e-mail dans les deux jours ouvrables d’un contact Microsoft, qui :

  • comprendra votre connecteur personnalisé ;
  • en saura plus sur la progression de votre développement ;
  • vous guidera tout au long du processus de certification.

Étape 2 : Répondre aux contraintes de la soumission

Pour maintenir un niveau élevé de qualité et de cohérence entre nos connecteurs certifiés, Microsoft dispose d’un ensemble d’exigences et de directives que votre connecteur personnalisé doit respecter pour la certification.

Donner un titre à votre connecteur

  • Doit exister et être écrit en anglais.
  • Doit être unique et se distinguer de tout titre de connecteur existant.
  • Doit être le nom de votre produit ou organisation.
  • Doit suivre les modèles de dénomination existants pour les connecteurs certifiés. Pour les éditeurs indépendants, le nom du connecteur doit suivre le modèle, Nom du connecteur (Independent Publisher).
  • Ne peut pas compter plus de 30 caractères.
  • Ne peut pas contenir les mots « API », « Connecteur », ou l’un de nos noms de produit Power Platform (par exemple, « Power Apps »).
  • Ne peut pas se terminer par un caractère non alphanumérique, y compris un retour chariot, une nouvelle ligne ou un espace vide.

Exemples

  • Titres corrects de connecteur : « Azure Sentinel », « Office 365 Outlook »
  • Mauvais titres de connecteur : « Azure Sentinel’s Power Apps Connector », « Office 365 Outlook API »

Écrire une description pour votre connecteur

  • Doit exister et être écrit en anglais.
  • Doit être exempt de fautes de grammaire et d’orthographe.
  • Doit décrire de manière concise le principal objectif et la valeur offerte par votre connecteur.
  • Ne peut pas être inférieur à 30 caractères ou supérieur à 500 caractères.
  • Ne peut pas contenir les noms de produit Power Platform (par exemple, « Power Apps »).

Concevoir une icône pour votre connecteur

Cette section ne s’applique pas aux éditeurs indépendants.

  • Créez un logo avec des dimensions 1:1 dans une plage de 100 x 100 à 230 × 230 pixels (pas de bords arrondis).
  • Doit avoir une couleur d’arrière-plan non transparente ni blanche (#ffffff) et une couleur autre que la valeur par défaut (#007ee5) qui correspond à la couleur d’arrière-plan de l’icône spécifiée.
  • Doit être unique pour toute autre icône de connecteur certifié.
  • Doit être envoyée au format PNG en tant que icon.png.
  • Les dimensions du logo sont inférieures à 70 % pour la hauteur et l’image de l’image. largeur avec un arrière-plan cohérent.
  • Assurez-vous que la couleur de la marque est une couleur hexadécimale valide et ne doit pas être blanche (#ffffff) ou par défaut (#007ee5).

Définir les résumés et descriptions des opérations et des paramètres

  • Doit exister et être écrit en anglais.
  • Doit être exempt de fautes de grammaire et d’orthographe.
  • Les résumés des opérations et des paramètres doivent être des phrases de 80 caractères au maximum et contenir uniquement des caractères alphanumériques ou des parenthèses.
  • Les descriptions des opérations et des paramètres doivent être des phrases descriptives complètes et se terminer par une ponctuation.
  • Ne peut pas contenir les noms de produit Microsoft Power Platform (par exemple, « Power Apps »).

Définir les réponses exactes de l’opération

  • Définissez les réponses de l’opération avec un schéma exact uniquement avec les réponses attendues.
  • N’utilisez pas les réponses par défaut avec une définition de schéma exacte.
  • Fournissez des définitions de schéma de réponse valides pour toutes les opérations du swagger.
  • Les schémas de réponse vides ne sont pas autorisés, sauf dans des cas particuliers où le schéma de réponse est dynamique. Cela signifie qu’aucun contenu dynamique ne est affiché dans la sortie et que les créateurs doivent utiliser JSON pour analyser la réponse.
  • Les opérations vides ne sont pas autorisées.
  • Supprimez les propriétés vides, sauf si elles sont nécessaires.

Vérifier les propriétés de Swagger

  • Assurez-vous que "openapidefinition" se trouve dans un fichier JSON correctement formaté.
  • Assurez-vous que la définition swagger est conforme à la norme OpenAPI 2.0 et à la norme étendue des connecteurs.

Vérifier les paramètres de connexion

  • Assurez-vous que la propriété est mise à jour avec les valeurs appropriées pour "UIDefinition" (nom d’affichage, description).

  • Si votre paramètre de connexion utilise l’authentification de base, assurez-vous que JSON est correctement formaté comme dans l’exemple suivant.

    {
  "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"
      }
    }
  }
}

  • Si votre paramètre de connexion utilise APIKey pour l’authentification de base, assurez-vous que JSON est correctement formaté comme dans l’exemple suivant.

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

  • Si votre paramètre de connexion utilise OAuth générique pour l’authentification de base, assurez-vous que JSON est correctement formaté comme dans l’exemple suivant.

    {
  "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
  }
}

  • Si votre paramètre de connexion a un fournisseur d’identité OAuth2, assurez-vous que le fournisseur d’identité figure dans la liste des fournisseurs OAuth2 pris en charge. Voici l’exemple du fournisseur d’identité GitHub OAuth2 :

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

  • Si votre paramètre de connexion utilise Microsoft Entra ID pour l’authentification, assurez-vous que JSON est au format correct comme dans l’exemple suivant.

    {
  "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
  }
}

Créer des chaînes en anglais de qualité

Les connecteurs sont localisés dans le cadre de la localisation Power Automate ; par conséquent, lorsque vous développez un connecteur, la qualité des chaînes en anglais est la clé de la qualité de la traduction. Voici quelques domaines principaux sur lesquels vous devez vous concentrer lorsque vous créez les valeurs des chaînes que vous fournissez.

  • Assurez-vous d’exécuter un programme de vérification orthographique pour vous assurer que toutes les valeurs de chaîne sont exemptes d’erreurs typographiques. S’il existe une chaîne en anglais incomplète, le résultat de la traduction est incomplet ou incorrect dans son contexte.

  • Assurez-vous que la forme de la phrase est complète. Si la phrase n’est pas complète, cela peut également générer des traductions de moins bonne qualité.

  • Assurez-vous que le sens de la phrase est clair. Si le sens de la phrase est ambigu, cela peut également générer des traductions de qualité inférieure ou incorrectes.

  • Veillez à ce que les résumés, les résumés x-ms et les descriptions soient grammaticalement corrects. Ne les copiez pas et ne les collez pas. Pour savoir comment ils sont affichés dans le produit, accédez à Conseils sur les chaînes de connecteur.

  • Évitez les chaînes composites au moment de l’exécution, si possible. Utilisez plutôt des phrases entièrement formées. Les chaînes ou les phrases concaténées rendent la traduction difficile ou peuvent entraîner une mauvaise traduction.

  • Si vous utilisez des abréviations, assurez-vous de les écrire en majuscule pour qu’elles soient clairement identifiables. Cela réduit le risque de les confondre avec une erreur typographique.

  • Les chaînes avec casse mixte (par ex. minimizeHighways or MinimizeHighways) sont généralement considérées comme non traduisibles. Si vous souhaitez localiser la valeur de la chaîne, vous devez corriger la chaîne avec casse mixte.

Étape 3 : Exécuter le vérificateur de solution pour valider votre connecteur

Le contrôleur de solution est un mécanisme permettant d’effectuer une analyse statique pour garantir que votre connecteur adhère aux normes requises par Microsoft pour la certification. Ajoutez votre connecteur à une solution dans Power Automate ou Power Apps et exécutez le vérificateur de solution en suivant les instructions de Valider un connecteur personnalisé avec le vérificateur de solution.

Regardez cette vidéo pour découvrir comment exécuter le contrôleur de solution.

Étape 4 : Ajouter des métadonnées

Vos artefacts de connecteur (fichiers) doivent contenir des métadonnées spécifiques décrivant le connecteur et son service final. Les informations fournies dans les métadonnées sont publiées dans la documentation de notre connecteur et seront accessibles au public par tous les utilisateurs. Ne donnez aucune information privée ou confidentielle et faites-nous savoir, via votre contact Microsoft, si vous rencontrez des problèmes en nous soumettant des informations. Pour savoir comment les métadonnées sont documentées, visitez l’une des pages de documentation spécifiques au connecteur sous Référence du connecteur.

Étape 4a : Propriétés de l’éditeur et de stackOwner

  • « éditeur » est le nom de votre entreprise ou organisation. Indiquez le nom complet de la société (par exemple, « Contoso Corporation »). Il doit être au format alphanumérique.

  • "stackOwner" désigne la société propriétaire ou l’organisation de la pile de services principale à laquelle le connecteur se connecte. Il doit être au format alphanumérique.

Serveur de publication Description Exemple
Vérifié L’éditeur et le stackOwner sont les mêmes, sauf si l’ISV construit un connecteur pour le compte d’un stackOwner. « éditeur » : « Tesla »,
« stackOwner » : « Tesla »
Indépendant Vous devez indiquer le propriétaire de la pile et le propriétaire de l’éditeur. « éditeur » : « Nirmal Kumar »,
« stackOwner » : « ITGlue »

Emplacement du fichier : apiProperties.json
Pour en savoir plus, accédez au Fichier Propriétés de l’API.

Syntaxe : Les propriétés publisher et stackOwner existent en tant que propriétés de niveau supérieur dans le fichier apiProperties.json. Ajoutez les lignes en surbrillance suivantes, comme indiqué. Veillez à saisir le nom de la propriété et le schéma exactement comme indiqué.

Capture d’écran montrant les propriétés publisher et stackOwner, qui sont disponibles dans les exemples d’extraits de code.

Étape 4c : Extraits d’exemple de code

Vous pouvez utiliser les extraits de code suivants pour copier et saisir vos informations. Assurez-vous d’ajouter les extraits de code aux fichiers appropriés aux emplacements appropriés, comme décrit dans la section précédente.

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

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

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

Notes

Il existe actuellement une limitation dans l’utilisation de la propriété stackOwner et de notre interface CLI Paconn. Pour plus d’informations, consultez l’article Limitations dans le fichier LISEZ-MOI.

Étape 4d : formatage du fichier JSON et limitations

  • Assurez-vous que vos propriétés sont correctement alignées.

  • Collez votre JSON dans Visual Studio Code. N’hésitez pas à utiliser des extensions telles que des correcteurs orthographiques et des plugins tels que les plugins JSON.

  • Les fichiers Swagger ne doivent pas dépasser 1 Mo.

    • Considérez la conception de votre connecteur avant de commencer à le construire. Évaluez si le connecteur doit être décomposé en deux (2) connecteurs ou plus.
    • Des fichiers swagger plus volumineux peuvent entraîner un retard lors de l’utilisation du connecteur.

    Par exemple, il existe trois (3) connecteurs HubSpot différents sur la plateforme.

    Capture d’écran des dossiers des trois connecteurs HubSpot.

Étape 4e : Valider vos fichiers de connecteur personnalisés

Exécutez le paconn validate --api-def [Location of apiDefinition.swagger.json]. Cet outil valide la définition de votre connecteur et vous informe des erreurs que vous devrez résoudre avant de l’envoyer.

Si votre connecteur utilise « OAuth » comme type d’authentification, ajoutez à votre application ces URL de redirection autorisées.

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

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

Étape 5 : Préparer les artefacts du connecteur

Cette étape devrait prendre environ une semaine.

Notes

  • Assurez-vous d’avoir respecté les exigences et vérifié la qualité de votre connecteur avant la certification. Dans le cas contraire, la certification sera retardée, car des modifications vous seront demandées.
  • Fournissez une version de production de l’URL de l’hôte. Les URL d’hôte de mise en lot, de développement et de test ne sont pas autorisées.

Vous allez envoyer à Microsoft un ensemble de fichiers appelé artefacts de connecteur, téléchargés à l’aide d’un outil de l’interface de ligne de commande fourni par Microsoft. Cet outil valide votre connecteur pour toute erreur de rupture.

Pour commencer, suivez ces étapes :

  1. Installez l’interface CLI des connecteurs Microsoft Power Platform en suivant les instructions d’installation.

  2. Connectez-vous à Microsoft Power Platform à l’aide de la ligne de commande en exécutant paconn login. Suivez les instructions pour vous connecter à l’aide du processus Code de l’appareil de Microsoft.

  3. Une fois authentifié, téléchargez vos fichiers de connecteur personnalisés :

    • Exécutez le paconn download. Sélectionnez l’environnement dans lequel se trouve votre connecteur personnalisé en indiquant son numéro dans la ligne de commande, puis sélectionnez le nom du connecteur personnalisé.

    L’outil télécharge vos artefacts de connecteur dans un dossier à l’emplacement du système de fichiers où vous avez exécuté paconn. Selon le type d’éditeur, vous verrez différents artefacts :

Serveur de publication Artefact
Vérifié apiDefinition.swagger.json
apiProperties.json
settings.json
Icône du connecteur
Indépendant apiDefinition.swagger.json
apiProperties.json

Les éditeurs vérifiés et les éditeurs indépendants téléchargent apiProperties.json dans leurs artefacts. Vous aurez besoin de définir l’IconBrandColor dans ce fichier.

  • Éditeurs vérifiés : définissez iconBrandColor sur la couleur de votre marque dans le fichier apiProperties.
  • Éditeurs indépendants : définissez iconBrandColor sur « #da3b01 »dans le fichier apiProperties.
    Capture d’écran d’une icône orange vif (da3b01).

Créer un artefact du fichier Readme

Un fichier Readme.md est nécessaire à la fois pour les éditeurs indépendants et les éditeurs vérifiés. Vous devez créer un fichier Readme.md pour documenter les caractéristiques et les fonctionnalités de votre connecteur. Pour un exemple de documentation à inclure, rendez-vous sur Exemple Readme.md. Regardez d’autres fichiers Readme.md dans notre Référentiel GitHub pour en savoir plus sur l’écriture d’un fichier Readme.md.

Si vous êtes un éditeur indépendant et que votre connecteur utilise OAuth, assurez-vous d’inclure des instructions sur la façon d’obtenir des informations d’identification.

Conseil

Problèmes connus et limites est une excellente section à maintenir pour garder vos utilisateurs à jour.

Étape 6 : Soumettre votre connecteur pour le déploiement

Pendant le processus de soumission, votre connecteur est en mode open source avec notre référentiel de connecteurs Microsoft Power Platform.

  1. Suivez les instructions décrites dans Soumettre votre connecteur pour certification par Microsoft pour la soumission à GitHub et au portail de certification.

    Si vous êtes un éditeur vérifié, vous devez soumettre un fichier script.csx si vous utilisez un code personnalisé.

  2. Une fois que vous avez soumis une demande d’extraction au référentiel open source, Microsoft déploiera et validera votre connecteur sous une à deux semaines. Si des mises à jour sont nécessaires, prévoyez 1 à 2 semaines supplémentaires.

    **Si votre connecteur dispose d’OAuth, soumettez le package dans ISV Studio et obtenez le nom d’API de votre demande de soumission de connecteur pour mettre à jour votre application.

    Dans le cadre de la soumission, Microsoft valide votre connecteur à l’aide des outils bot CLA, Swagger Validator et Breaking Change Detector. Si vous devez résoudre les erreurs de swagger, consultez Corriger les erreurs de Swagger Validator.

Étape 7 : Attentes pour les tests effectués par des éditeurs vérifiés

Après avoir validé votre connecteur, nous vous demanderons d’effectuer des tests approfondis.

  1. Suivez les instructions dans Tester votre connecteur en certification pour créer un environnement dans la région Aperçu à des fins de préparation pour vos tests.

  2. Dans un délai d’une semaine, informez votre contact Microsoft que vous avez terminé les tests afin que nous puissions commencer le déploiement.

  3. Une fois la fonctionnalité et le contenu de votre connecteur validés par Microsoft et par vous-même, nous préparerons le connecteur pour le déploiement dans la région Version préliminaire à des fins de test.

Étape 8 : Attendre le déploiement

Une fois votre connecteur validé pour les tests, nous allons le déployer sur l’ensemble des produits et des régions.

Important

En moyenne, il faut 3 à 4 semaines pour déployer le connecteur. Cela est nécessaire quelle que soit la taille ou la complexité de votre connecteur, qu’il soit nouveau ou mis à jour. Afin de protéger l’intégrité, le connecteur sera soumis aux mêmes tâches de validation pour tester la fonctionnalité et le contenu qui sont suivies dans chaque déploiement.

Nous vous envoyons par e-mail les noms des régions dans lesquelles le connecteur sera déployé, car le déploiement dans les régions est effectué par étapes. En cas de retard ou de gel du déploiement, les éditeurs vérifiés peuvent trouver le statut dans le Contrôle d’activité du Portail ISV. Les éditeurs indépendants seront informés par e-mail.

Déploiement de production

Notre déploiement de connecteur prévoit un début de production les vendredi matins, PST/PDT. Vous devez informer Microsoft lorsque vous serez prêt pour le déploiement en production au moins 24 heures à l’avance pour que nous puissions inclure votre connecteur dans le prochain déploiement planifié. Les éditeurs vérifiés peuvent nous informer dans le Contrôle Activité du Portail ISV. Les éditeurs indépendants peuvent informer leur contact Microsoft.

Déploiement régional

Le déploiement dans les différentes régions s’effectue selon un ordre quotidien prédéterminé. Les régions sont :

  • Test.
  • Version préliminaire États-Unis.
  • Asie, sauf Japon et Inde.
  • Europe, sauf Royaume-Uni.
  • Brésil, Canada, Japon et Inde.
  • Australie, Royaume-Uni et États-Unis.

Par exemple, si votre connecteur doit être déployé le lundi, il se déploie dans la région de test le 1er jour. Ensuite, il se déploie dans la région Version préliminaire États-Unis le 2ème jour. Le déploiement se poursuit chaque jour jusqu’à ce que le connecteur soit déployé dans l’ensemble des six régions.

Nous n’effectuons pas de déploiements les samedis, dimanches et jours fériés aux États-Unis.

Au fur et à mesure que votre connecteur termine la certification, nous vous contactons au sujet d’une opportunité marketing pour le connecteur sur le Blog Power Automate.

Étape 9 : Explorer les options de post-déploiement

Voici quelques options que vous pouvez explorer une fois votre connecteur déployé :

Liste de vérification avant soumission

Avant de passer à Soumettre votre connecteur pour certification par Microsoft, veillez à :

Conseil

  • Créez des vidéos YouTube, des blogs ou d’autres contenus pour partager des exemples ou des captures d’écran sur la façon de démarrer avec le connecteur.
    - Inclure les liens dans le fichier Readme.md afin que nous puissions l’ajouter à nos documents.
  • Ajoutez des info-bulles à votre fichier swagger pour aider vos utilisateurs à mieux réussir.

Si vous n’êtes pas un éditeur vérifié (et pas un éditeur indépendant), il vous est demandé d’accepter notre accord de partenariat et notre accord de non-divulgation lorsque vous soumettrez la certification Microsoft. Si vous souhaitez consulter ces conditions et la langue avant l’envoi, adressez-vous à votre contact Microsoft.

Étape suivante

Soumettre votre connecteur pour certification par Microsoft

Fournir des commentaires

Nous apprécions grandement les commentaires sur les problèmes liés à notre plateforme de connecteurs ou les idées de nouvelles fonctionnalités. Pour fournir des commentaires, accédez à Soumettre des problèmes ou obtenir de l’aide avec les connecteurs et sélectionnez votre type de commentaire.