Delen via

Connector- en AI-compatibele connectorbestanden voorbereiden voor certificering Power Platform

  • Artikel

Dit proces geldt voor zowel geverifieerde als onafhankelijke uitgevers.

Nadat u klaar bent met het ontwikkelen van uw aangepaste connector en/of AI-connector, volgt u deze stappen om deze voor te bereiden op certificering en de connector- en/of AI-connectorbestanden te genereren die u bij Microsoft kunt indienen.

Notitie

Dit artikel biedt informatie over het certificeren van aangepaste connectors in Azure Logic Apps, Microsoft Power Automate en Microsoft Power Apps en AI-compatibele connectorbestanden voor Microsoft Copilot Studio. Lees voordat u de stappen in dit artikel volgt eerst het volgende: Laat uw connector en/of actie (plug-in) certificeren.

Stap 1: Registreer uw connector en/of AI-compatibele connector (alleen van toepassing op onafhankelijke uitgevers)

Deze sectie is niet van toepassing op geverifieerde uitgevers.

U hoeft de ontwikkeling van uw aangepaste connector en/of AI-connector niet af te ronden om certificering aan te vragen. Om het certificeringsproces te starten, registreert u uw connector en/of AI-connector voor certificering door ons registratieformulier in te vullen .

Verwacht binnen twee werkdagen een e-mail van een Microsoft-contactpersoon, die:

  • Begrijpt uw aangepaste connector, connector en/of AI-compatibele connector.
  • meer informatie krijgt over uw ontwikkelingsvoortgang.
  • u e-mailt over het certificeringsproces.

Stap 2: U moet aan de indieningsvereisten voor connectoren voldoen

Om een hoge kwaliteit en consistentie tussen onze gecertificeerde connectoren te behouden, heeft Microsoft een reeks vereisten en richtlijnen opgesteld waaraan uw aangepaste connector moet voldoen voor certificering.

Geef uw connector een titel

Uw titel moet aan de volgende vereisten voldoen.

  • De titel moet aanwezig zijn en zijn geschreven in het Engels.
  • De titel moet uniek zijn en te onderscheiden zijn van elke bestaande connector- en of invoegtoepassingstitel.
  • De titel moet de naam zijn van uw product of organisatie.
  • De titel moet bestaande naamgevingspatronen volgen voor gecertificeerde connectoren en/of invoegtoepassingen. Voor onafhankelijke uitgevers moet de connectornaam het volgende patroon volgen Connector and/or plugin Name (Independent Publisher).
  • De titel mag niet langer zijn dan 30 tekens.
  • Mag niet de woorden API, Connector of een van onze Power Platform productnamen bevatten (bijvoorbeeld Power Apps).
  • De titel mag niet eindigen met een niet-alfanumeriek teken, inclusief regelterugloop, nieuwe regel of spatie.

Voorbeelden

  • Goede connector- en/of plugintitels: Azure Sentinel*, *Office 365 Outlook
  • Slechte connector- en/of plugintitels: Azure Sentinel's Power Apps Connector, Office 365 Outlook API

Schrijf een beschrijving voor uw connector

De beschrijving moet aan de volgende vereisten voldoen.

  • De titel moet aanwezig zijn en zijn geschreven in het Engels.
  • De beschrijving mogen mag geen grammatica- of spelfouten bevatten.
  • De beschrijving moet beknopt het hoofddoel en de toegevoegde waarde van uw connector aangeven.
  • De beschrijving mag niet korter zijn dan 30 tekens of langer dan 500 tekens.
  • De beschrijving mag geen Power Platform-productnamen (bijvoorbeeld ′Power Apps′) bevatten.

Een pictogram voor uw connector ontwerpen (alleen van toepassing voor geverifieerde uitgevers)

Deze sectie is niet van toepassing op onafhankelijke uitgevers.

  • Maak een logo met afmetingen 1:1 binnen een bereik van 100 x 100 tot 230 x 230 pixels (geen afgeronde randen).
  • Gebruik een niet-transparante, niet-witte (#ffffff) achtergrond en niet-standaardkleur (#007ee5) die overeenkomt met de door u opgegeven achtergrondkleur van het pictogram.
  • Zorg dat het pictogram uniek is en afwijkt van elk ander gecertificeerd connectorpictogram.
  • Dien het logo in PNG-formaat in als <icon>.png.
  • Stel de logo-afmetingen in op minder dan 70% voor de hoogte en breedte van de afbeelding, met een consistente achtergrond.
  • Zorg ervoor dat de merkkleur een geldige hexadecimale kleur is. Deze mag niet wit (#ffffff) of standaard (#007ee5) zijn.

Bewerkings- en parameteroverzichten en -beschrijvingen definiëren

De overzichten en beschrijvingen moeten aan de volgende vereisten voldoen.

  • De titel moet aanwezig zijn en zijn geschreven in het Engels.
  • De beschrijving mogen mag geen grammatica- of spelfouten bevatten.
  • Bewerkings- en parameteroverzichten moeten zinnen zijn van 80 tekens of korter en mogen alleen alfanumerieke tekens of haakjes bevatten.
  • Bewerkings- en parameterbeschrijvingen moeten volledige, beschrijvende zinnen zijn en eindigen met interpunctie.
  • De beschrijving mag geen Microsoft Power Platform-productnamen (bijvoorbeeld "Power Apps") bevatten.

Exacte bewerkingsreacties definiëren

De bewerkingsreacties moeten aan de volgende vereisten voldoen.

  • Definieer bewerkingsreacties met een exact schema, alleen met verwachte reacties.
  • Gebruik geen standaardresponses met een exacte schemadefinitie.
  • Geef geldige definities van het responsschema op voor alle bewerkingen in de swagger.
  • Lege responsschema's zijn niet toegestaan, behalve in speciale gevallen waarin het responsschema dynamisch is. Dit betekent dat er geen dynamische inhoud wordt weergegeven in de uitvoer en dat makers JSON moeten gebruiken om het antwoord te parseren.
  • Lege bewerkingen zijn niet toegestaan.
  • Verwijder lege eigenschappen, tenzij ze vereist zijn.

Controleer de Swagger-eigenschappen

De eigenschappen moeten aan de volgende vereisten voldoen.

  • Zorg ervoor dat de "openapidefinition" in een correct geformatteerd JSON-bestand staat.
  • Zorg ervoor dat de swagger-definitie voldoet aan de 2.0-standaard en de uitgebreide standaard van de connectoren. OpenAPI

Verbindingsparameters controleren

De parameters moeten aan de volgende vereisten voldoen.

  • Zorg ervoor dat de eigenschap wordt bijgewerkt met de juiste waarden voor "UIDefinition" (weergavenaam, beschrijving).

  • Als uw verbindingsparameter basisverificatie gebruikt, zorg er dan voor dat JSON correct is opgemaakt, zoals in het volgende voorbeeld.

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

  • Als uw verbindingsparameter APIKey gebruikt als verificatie, zorg er dan voor dat JSON correct is opgemaakt, zoals in het volgende voorbeeld.

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

  • Als uw verbindingsparameter Generic OAuth als authenticatie heeft, zorg er dan voor dat JSON correct is geformatteerd, zoals in het volgende voorbeeld.

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

  • Als uw verbindingsparameter een OAuth2-identiteitsprovider heeft, zorg er dan voor dat de identiteitsprovider uit de lijst met ondersteunde OAuth2-providers komt. Hieronder volgt het voorbeeld van de GitHub OAuth2-identiteitsprovider:

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

  • Als uw verbindingsparameter Microsoft Entra ID gebruikt als verificatie, zorg er dan voor dat JSON correct is opgemaakt, zoals in het volgende voorbeeld.

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

Goede teksten schrijven in het Engels

Connectoren zijn gelokaliseerd als onderdeel van de Power Automate-lokalisatie. Wanneer u een connector ontwikkelt, is de kwaliteit van de Engelse taal belangrijk voor de vertaalkwaliteit. Hier zijn enkele belangrijke gebieden waarop u zich moet richten bij schrijven van de teksten die u opgeeft.

  • Voer een spellingcontrole uit om ervoor te zorgen dat alle tekenreeksen vrij zijn van spelfouten. Als er een onvolledige tekenreeks in het Engels is, is het vertaalresultaat ook onvolledig of onjuist in de context.

  • Zorg ervoor dat de zin volledig is. Als de zin niet compleet is, levert dat ook vertalingen van mindere kwaliteit op.

  • Zorg ervoor dat de betekenis van de zin duidelijk is. Als de betekenis van de zin dubbelzinnig is, kan dat ook leiden tot slechtere kwaliteit of onjuiste vertalingen.

  • Zorg ervoor dat samenvattingen, x-ms-samenvattingen en beschrijvingen grammaticaal correct zijn. Kopieer en plak ze niet. Ga naar Connector string guidance voor meer informatie over hoe ze in het product worden weergegeven.

  • Vermijd indien mogelijk tekenreeksen die tijdens runtime worden samengesteld. Gebruik in plaats daarvan volledig gevormde zinnen. Aaneengeschakelde tekenreeksen of zinnen maken zijn moeilijk om te vertalen, of kunnen een verkeerde vertaling veroorzaken.

  • Als u afkortingen gebruikt, schrijf ze dan met een hoofdletter schrijft om het duidelijk te maken. Dit verkleint de kans dat het wordt aangezien voor een typefout.

  • Tekenreeksen in CaMel-vorm (bijvoorbeeld: minimizeHighways of MinimizeHighways) worden doorgaans als niet-vertaalbaar beschouwd. Als u de tekenreekswaarde wilt lokaliseren, moet u de CaMel-vorm aanpassen.

Stap 3: Voer de oplossingscontrole uit om uw connector te valideren

Oplossingscontrole is een mechanisme om statische analyses uit te voeren om ervoor te zorgen dat uw connector voldoet aan de normen die Microsoft hanteert voor certificering. Voeg uw connector toe aan een oplossing in Power Automate of Power Apps en voer de oplossingscontrole uit door de instructies te volgen in Een aangepaste connector valideren met de oplossingscontrole.

Bekijk deze video om te leren hoe u de Solution Checker uitvoert.

Stap 4: U moet aan de indieningsvereisten voor invoegtoepassingen voldoen

Deze sectie is van toepassing als u ook de bijbehorende connectorinvoegtoepassing ter certificering indient.

Stap 5: Bereid de artefacten voor de connector en/of invoegtoepassing voor

Notitie

  • Zorg ervoor dat u de specificaties volgt en de kwaliteit van uw connector en/of AI-connector garandeert voordat u de certificering aanvraagt. Als u dit niet doet, wordt de certificering vertraagd, omdat u wordt gevraagd wijzigingen aan te brengen.
  • Geef een productieversie van de host-URL op. Staging-, dev- en testhost-URL's zijn niet toegestaan.

U dient een set bestanden in bij Microsoft. Dit is een oplossing die is gegenereerd via de Maker Portal of Microsoft Copilot Studio. Volg de stappen in dit gedeelte om uw bestanden te verpakken.

Verpakkingsguide voor connectoren en invoegtoepassingen

De procedures in dit gedeelte leiden u door verschillende verpakkingsscenario's. Als u alleen een aangepaste connector wilt verpakken, gebruikt u het eerste scenario. Als u zowel een aangepaste connector als AI-compatibele connector wilt verpakken, gebruikt u het tweede scenario. Als u een bestaande connector en een AI-compatibele connector wilt verpakken, gebruikt u het laatste scenario.

Uw aangepaste connector inpakken en indienen voor certificering

  1. Maak een aangepaste connector voor een oplossing.

  2. Voer de oplossingscontrole uit op uw connectoroplossing in stap 1.

  3. Exporteer de connectoroplossing.

  4. Maak een flow (testen) met behulp van de nieuw gemaakte aangepaste connector of voeg een bestaande flow toe aan de oplossing.

  5. Exporteer de stroomoplossing.

  6. Maak een pakket met de oplossingen uit stap 3 en 5.

  7. Maak een intro.md-bestand.

  8. Maak het uiteindelijke pakket als een zip-bestand, met de volgende indeling:

    Schermafbeelding van de mappen en bestanden in een zipbestand voor een gecertificeerde connector die gecertificeerd moet worden.

Notitie

De namen van de mappen en bestanden buiten de oplossing dienen alleen ter referentie. U kunt ze naar eigen wens kiezen. Breng echter geen wijzigingen aan in de bestanden in de oplossing.

  1. Upload het pakket naar een opslagblob en genereer een SAS-URL . Zorg ervoor dat uw SAS-URI minimaal 15 dagen geldig is.
  2. Dien uw pakket in bij het Partner Center.

Verpak uw aangepaste connector en AI-compatibele connector voor certificering

  1. Volg stap 1 tot en met 5 in Uw aangepaste connector verpakken en ter certificering indienen in dit artikel.

  2. Maak een plug-in in de Microsoft Copilot Studio portal en exporteer deze als een oplossing.

  3. Maak een pakket van het volgende:

  4. Maak een intro.md-bestand.

  5. Maak het uiteindelijke pakket als een zip-bestand, met de volgende indeling.

    Schermafbeelding van de mappen en bestanden in een zipbestand voor een gecertificeerde connector en plug-in die gecertificeerd moet worden.

Notitie

De namen van de mappen en bestanden buiten de oplossing dienen alleen ter referentie. U kunt ze naar eigen wens kiezen. Breng echter geen wijzigingen aan in de bestanden in de oplossing.

  1. Upload het pakket naar een opslagblob en genereer een SAS-URL . Zorg ervoor dat uw SAS-URI minimaal 15 dagen geldig is.
  2. Dien uw pakket in bij het Partner Center.

Verpak bestaande gecertificeerde connector en AI-compatibele connector voor certificering

  1. Maak een oplossing in Power Automate en voeg de reeds gecertificeerde connector eraan toe.

  2. Volg stap 2 tot en met 4 in Uw aangepaste connector verpakken en ter certificering indienen in dit artikel.

  3. Maak een plug-in in Copilot Studio en exporteer deze als een oplossing.

  4. Exporteer de invoegtoepassing als oplossing.

  5. Maak een pakket van het volgende:

  6. Maak een intro.md-bestand.

  7. Maak het uiteindelijke pakket als een zip-bestand, met de volgende indeling.

    Schermafbeelding van de mappen en bestanden in een zipbestand voor een bestaande gecertificeerde connector en plug-in die gecertificeerd moet worden.

Notitie

De namen van de mappen en bestanden buiten de oplossing dienen alleen ter referentie. U kunt ze naar eigen wens kiezen. Breng echter geen wijzigingen aan in de bestanden in de oplossing.

  1. Upload het pakket naar een opslagblob en genereer een SAS-URL . Zorg ervoor dat uw SAS-URI minimaal 15 dagen geldig is.
  2. Dien uw pakket in bij het Partner Center.

Zowel geverifieerde uitgevers als onafhankelijke uitgevers downloaden openapidefinition.json hun artefacten. U moet IconBrandColor in dit bestand instellen.

  • Geverifieerde uitgevers: Stel iconBrandColor in op uw merkkleur in het openapidefinition-bestand.
  • Onafhankelijke uitgevers: Stel iconBrandColor in op "#da3b01" in het openapidefinition-bestand.
    Schermafbeelding van een feloranje (da3b01) pictogram.

Een intro.md-artefact maken

Een intro.md-bestand is nodig voor zowel onafhankelijke uitgevers als geverifieerde uitgevers. U moet een intro.md-bestand maken om de kenmerken en functionaliteit van uw connector te documenteren. Ga naar het Readme.md-voorbeeld voor een voorbeeld van documentatie die u kunt opnemen. Als u wilt leren hoe u een intro.md-bestand schrijft, bekijk dan andere intro.md-bestanden (ook bekend als Readme.md-bestanden) in onze GitHub-repository.

Als u een onafhankelijke uitgever bent en uw connector OAuth gebruikt, zorg er dan voor dat u instructies opneemt over hoe u inloggegevens kunt verkrijgen.

Tip

Bekende problemen en beperkingen is een geweldige sectie om te onderhouden, zodat uw gebruikers op de hoogte blijven.

Stap 6: Valideer het pakket op structuur

Het pakketvalidatiescript valideert de pakketstructuur en helpt u bij het genereren van het pakket in een acceptabel formaat voor certificering. Download het pakketvalidatiescript met deze link: ConnectorPackageValidator.ps1.

Om het script uit te voeren, volgt u deze stappen:

  1. Open Windows PowerShell in de beheerdersmodus.

    Schermafbeelding van Windows PowerShell in beheerdersmodus.

  2. Wijzig de locatie van de schijf door in te voeren cd /.

    Het volgende voorbeeld gebruikt C:\.

    Schermafbeelding van de syntaxis om het station te wijzigen.

  3. Ga naar het pad waar u het pakketvalidatiescript hebt gedownload.

    Als het pad bijvoorbeeld C:\Users\user01\Downloads is, voert u in cd .\Users\user01\Downloads\.

    Schermafbeelding van de syntaxis om het pad te wijzigen.

  4. Stel het uitvoeringsbeleid in op onbeperkt door de volgende opdracht in te voeren:

    Set-ExecutionPolicy -ExecutionPolicy Unrestricted

    Schermafbeelding van de syntaxis om het uitvoeringsbeleid in te stellen.

    Met deze opdracht kan PowerShell zonder enige beperking worden uitgevoerd.

  5. Bevestig uw invoer door Y in te voeren, wat Ja betekent.

  6. Voer ConnectorPackageValidator.ps1 uit met de volgende stappen:

    1. Voer het zip-bestand in dat het connectorpakket bevat.
    2. Geef aan of de AI-plug-in is ingeschakeld.

    Zoals in het volgende voorbeeld wordt getoond, is het eerste argument een geldig zip-bestandspad dat het pakket bevat. Het tweede argument is yes/y om aan te geven dat de AI-plug-in is ingeschakeld, of no/n om aan te geven dat deze is uitgeschakeld.

    Schermafbeelding van de syntaxis voor het uitvoeren van ConnectorPackageValidator.ps1.

    Als de pakketstructuur correct is, wordt het volgende succesbericht weergegeven:

    Schermafbeelding van het succesbericht.

    Als er een probleem is met de pakketstructuur, geeft het script details over het probleem door de defecten in de pakketstructuur te detecteren en te markeren.

    Schermafbeelding van het probleem.

Stap 7: Dien uw connector en/of invoegtoepassing in voor certificering

Tijdens het indieningsproces maakt u uw connector en/of plugin beschikbaar als open source in onze Microsoft Power Platform Connectors-repository.

  1. (Voor onafhankelijke uitgevers) Volg de instructies in het Certificeringsproces voor onafhankelijke uitgevers om het pakket ter certificering bij Microsoft in te dienen.

  2. (Voor geverifieerde uitgevers) Volg de instructies in Certificeringsproces voor geverifieerde uitgevers om het pakket in te dienen bij Microsoft voor certificering in Partner Center.

    Als u een geverifieerde uitgever bent, moet u een script.csx-bestand indienen als u aangepaste code gebruikt.

    Als uw connector OAuth heeft, geeft u de client-ID en het geheim op in het Partnercentrum. U kunt ook de APIname uit uw connectorindieningsverzoek ophalen om uw app bij te werken.

    Als onderdeel van de indiening certificeert en/of plugt Microsoft uw connector in. Als u problemen met Swagger-fouten wilt oplossen, gaat u naar Swagger Validator-fouten oplossen.

Controlelijst voordat u indient

Voordat u verdergaat met het indienen van uw connector voor Microsoft-certificering, moet u het volgende doen:

Voor vragen over certificering

U moet Microsoft Teams deelnemen aan de Office Hours-vergadering. Als u toegang nodig hebt, bekijk dan uw opties in Microsoft Teams.

Neem deel aan de Office Hours Meeting elke dinsdag van 15:30 tot 16:30 uur, UTC (Coordinated Universal Time).

Tip

  • Maak YouTube-video's, blogs of andere inhoud om voorbeelden of schermopnamen te delen om aan de slag te gaan met de connector en/of invoegtoepassing.
  • Voeg de links toe aan het bestand intro.md , zodat we deze aan onze documentatie kunnen toevoegen.
  • Voeg tooltips toe aan uw Swagger-bestand om uw gebruikers succesvoller te maken.

Volgende stap