Certificeringsproces voor niet-Microsoft-uitgevers

Dit proces is voor niet-Microsoft uitgevers (met uitzondering van onafhankelijke uitgevers). Als u een onafhankelijke uitgever bent, gaat u naar Certificeringsproces voor onafhankelijke uitgevers.

Als u klaar bent met het ontwikkelen van uw aangepaste connector, voert u de volgende stappen uit om uw connector voor te bereiden op certificering en de connectorbestanden te genereren die u bij Microsoft moet indienen.

Notitie

Deze onderwerp biedt informatie voor het certificeren van aangepaste connectors in Azure Logic Apps, Power Automate en Power Apps. Voordat u de stappen in dit artikel uitvoert, moet u ervoor zorgen dat u het overzicht Uw connector laten certificeren hebt gelezen en uw aangepaste connector registreert bij Microsoft.

Stap 1: Uw connector registreren

U hoeft niet klaar te zijn met het ontwikkelen van uw aangepaste connector om certificering aan te vragen. Om met het certificeringsproces te beginnen, registreert u uw connector voor certificering door ons registratieformulier in te vullen.

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

  • Uw aangepaste connector begrijpt.
  • Meer informatie geeft over uw ontwikkelingsvoortgang.
  • U begeleidt bij het certificeringsproces.

Stap 2: Voldoen aan de indieningsvereisten

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

  • De titel moet aanwezig zijn en zijn geschreven in het Engels.
  • De titel moet uniek zijn en te onderscheiden zijn van elke bestaande connectortitel.
  • De titel moet de naam zijn van uw product of organisatie.
  • De titel moet bestaande naamgevingspatronen volgen voor gecertificeerde connectors.
  • De titel mag niet langer zijn dan 30 tekens.
  • De titel mag de woorden "API", "Connector" of een van onze Power Platform-productnamen (bijvoorbeeld "Power Apps") niet bevatten.
  • De titel mag niet eindigen met een niet-alfanumeriek teken, inclusief regelterugloop, nieuwe regel of spatie.

Voorbeelden

  • Goede connectortitels: "Azure Sentinel", "Office 365 Outlook"
  • Slechte connectortitels: "Azure Sentinel's Power Apps Connector", "Office 365 Outlook API"

Schrijf een beschrijving voor uw connector

  • 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

Deze sectie is niet van toepassing op onafhankelijke uitgevers.

  • Maak een logo van ongeveer 160 × 160 pixels binnen een vierkant van ongeveer 230 × 230 pixels (geen afgeronde randen).
  • Moet een niet-transparante, niet-witte kleur (#ffffff) achtergrond en niet-standaard kleur (#007ee5) bevatten die overeenkomt met de door u opgegeven achtergrondkleur van het pictogram.
  • Het pictogram moet uniek zijn en afwijken van elk ander gecertificeerd connectorpictogram.
  • Het pictogram moet worden verzonden in PNG-indeling als icon.png.

Bewerkings- en parameteroverzichten en -beschrijvingen definiëren

  • 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

  • Definieer bewerkingsreacties met een exact schema, alleen met verwachte reacties.
  • Gebruik geen standaardantwoorden met een exacte schemadefinitie.
  • Geef geldige definities van het responsschema op voor alle bewerkingen in de swagger. Lege responsschema's zijn niet toegestaan. Dit betekent dat er geen dynamische inhoud wordt weergegeven in de uitvoer en dat makers JSON moeten gebruiken om het antwoord te ontleden.

Goede teksten schrijven in het Engels

Connectors 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.

  • Zorg ervoor dat u spellingcontrole uitvoert 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.

  • 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.

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

Stap 3: Metagegevens toevoegen

Uw connectorartefacten (bestanden) moeten specifieke metagegevens bevatten die de connector en de eindservice beschrijven. De informatie die wordt geboden in metagegevens wordt gepubliceerd in onze connectordocumentatie en is openbaar toegankelijk voor alle gebruikers. Geef geen persoonlijke of vertrouwelijke informatie op en laat het ons via uw Microsoft-contactpersoon weten als er problemen zijn met het verstrekken van deze informatie. Bezoek een van de connectorspecifieke documentatiepagina's onder Connectorreferentie om te zien hoe de metagegevens worden gedocumenteerd.

Stap 3a: Eigenschappen van publisher en stackOwner

  • "publisher" is de naam van uw bedrijf of organisatie. Geef de volledige bedrijfsnaam op (bijvoorbeeld "Contoso Corporation"). Dit moet een alfanumerieke notatie hebben.

  • "stackOwner" is het bedrijf of de organisatie die eigenaar is van de back-end servicestack waarmee de connector verbinding maakt. Dit moet een alfanumerieke notatie hebben.

Bestandslocatie: apiProperties.json

Syntaxis: De eigenschap uitgever en eigenaar van stack bestaan als eigenschap op het hoogste niveau binnen het bestand apiProperties.json. Voeg de volgende gemarkeerde regels toe zoals weergegeven. Zorg ervoor dat u de eigenshapsnaam en het schema precies invoert zoals weergegeven.

Schermopname met de eigenschappen publisher en stackOwner, die beschikbaar zijn in voorbeeldcodefragmenten.

Code met twee regels die rood zijn gemarkeerd. De twee regels zijn voor uitgever en stackOwner, en bevinden zich direct na het afsluitende vierkante haakje in "capaciteiten":[ "actions" ] :::image-end:::

Stap 3b: Metagegevens van product of eindservice

  • Met "contact" wordt beschreven hoe gebruikers contact kunnen opnemen met de ondersteuningsresources voor producten of eindservices voor hulp of probleemoplossing. Geef één waarde op voor elk van de volgende:

    • Naam van uw ondersteuningsteam
    • URL van uw ondersteuningswebsite
    • Ondersteuning e-mail
  • "Website" is de website van het product of de eindservice. De website geeft gebruikers informatie over het product of de eindservice die ze gebruiken met de connector. Dit moet een URL zijn.

  • "Privacybeleid" verwijst naar het openbare privacybeleid van het product of de eindservice, of het bedrijf of de organisatie. Dit moet een URL zijn.

  • Categorieën verwijzen naar een logische classificatie van uw connector onder maximaal twee van de volgende categorieën: AI, Bedrijfsbeheer, Business Intelligence, Samenwerking, Handel, Communicatie, Inhoud en bestanden, Financiën, Gegevens, Human resources, Internet of Things, IT-activiteiten, Lifestyle en entertainment, Marketing, Productiviteit, Verkoop en CRM, Beveiliging, Sociale media, Website.

Bestandslocatie: apiDefinition.swagger.json

Syntaxis: Het object contact is een standaardveld dat wordt gedefinieerd door het OpenAPI-contract onder de eigenschap info op het hoogste niveau. Website, Privacybeleid, en Categorieën wordt gedefinieerd in een aangepaste extensie op het hoogste niveau genaamd x-ms-connector-metadata. De waarde van de eigenschap Categorieën is een door puntkomma's gescheiden tekenreeks. Voeg de rood omlijnde codefragmenten toe zoals weergegeven. Zorg ervoor dat u het schema precies invoert zoals weergegeven; verander de propertyName niet.

Schermafbeelding met x-ms-connector-metadata, die als bruikbaar voorbeeld beschikbaar is in Voorbeeldcodefragmenten

Code die het blok toont dat het in rood gemarkeerde contactobject definieert. Dit blok moet direct onder de omschrijving staan. Een ander blok, x-ms-connector-metadata, is ook rood gemarkeerd. Dit blok moet direct onder de paden staan: {}

Stap 3c: Voorbeeldcodefragmenten

U kunt de volgende codefragmenten gebruiken om uw gegevens te kopiëren en in te voeren. Zorg ervoor dat u de fragmenten aan de juiste bestanden op de juiste locaties toevoegt, zoals beschreven in de voorgaande sectie.

    "publisher": "_____",
    "stackOwner": "_____"
    "contact": {
      "name": "_____",
      "url": "_____",
      "email": "_____"
    }
    "x-ms-connector-metadata": [
      {
        "propertyName": "Website",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Privacy policy",
        "propertyValue": "_____"
      },
      {
        "propertyName": "Categories",
        "propertyValue": "_____;_____"
      }
    ]

Notitie

Er is momenteel een beperking in het gebruik van de eigenschap stackOwner en onze Paconn CLI-tool. Zie Beperkingen in het README-bestand voor meer informatie.

Stap 3d: Valideer uw aangepaste connectorbestanden

Voer paconn validate --api-def [Location of apiDefinition.swagger.json] uit. Met deze tool wordt de connectordefinitie gevalideerd en kunt u zien welke fouten u moet oplossen voordat u de connector indient.

Als de connector gebruikmaakt van OAuth als verificatietype, voegt u deze goedgekeurde omleidings-URL's toe aan uw app:

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

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

Stap 4: De connectorartefacten voorbereiden

Deze stap zou ongeveer een week in beslag moeten nemen.

Notitie

Zorg ervoor dat u de specificaties hebt gevolgd en de kwaliteit van uw connector voorafgaand aan certificering hebt gecontroleerd. Als u dit niet doet, wordt de certificering vertraagd, omdat u wordt gevraagd wijzigingen aan te brengen.

U dient een set bestanden met de naam connectorartefacten in bij Microsoft, die wordt gedownload met behulp van een opdrachtregelinterface (CLI)-tool van Microsoft. Met deze tool wordt uw connector op eventuele fouten gevalideerd.

Volg deze stappen om aan de slag te gaan:

  1. Installeer Microsoft Power Platform Connectors CLI-tool door de installatie-instructies te volgen.

  2. Meld u aan bij het Microsoft Power Platform via de opdrachtregel door paconn login uit te voeren. Volg de instructies om u aan te melden met de apparaatcodeprocedure van Microsoft.

  3. Nadat u bent geverifieerd, downloadt u uw aangepaste connectorbestanden:

    • Voer paconn download uit. Selecteer de omgeving waarin de aangepaste connector zich bevindt door het nummer op de opdrachtregel op te geven. Selecteer vervolgens de naam van de aangepaste connector.

    De tool downloadt uw connectorartefacten in een map naar de locatie van het bestandssysteem waar u paconn hebt uitgevoerd. Afhankelijk van het type uitgever ziet u verschillende artefacten:

    Uitgever Artefact
    Onafhankelijke uitgever apiDefinition.swagger.json
    apiProperties.json
    Niet-Microsoft uitgever (anders dan onafhankelijk) apiDefinition.swagger.json
    apiProperties.json
    settings.json
    Het connectorpictogram

Een Readme-bestandsartefact maken

Een Readme.md-bestand is nodig voor zowel onafhankelijke uitgevers als niet-Microsoft-uitgevers. U moet een Readme.md-bestand maken om de kenmerken en functionaliteit van uw connector te documenteren. Voor een voorbeeld van op te nemen documentatie gaat u naar Voorbeeld van Readme.md.

Stap 5: Uw connector indienen voor implementatie

Notitie

Tijdens het indieningsproces opensourcet u uw connector bij onze Microsoft Power Platform Connectors-opslagplaats.

  1. Volg de instructies in Uw connector indienen voor Microsoft-certificering voor het indienen bij GitHub en de certificeringsportal.

  2. Zodra u een pull-verzoek hebt ingediend bij de opensource-opslagplaats, zal Microsoft uw connector binnen twee werkdagen implementeren en valideren. Als er updates nodig zijn, moet u rekening houden met twee werkdagen extra.

    Als onderdeel van de indiening valideert Microsoft uw connector met behulp van de CLA-bot, Swagger Validator en Breaking Change Detector-tools. Als u swagger-fouten wilt oplossen, gaat u naar Swagger-validatiefouten corrigeren.

Stap 6: Verwachtingen voor testen gedaan door niet-Microsoft-uitgevers

Nadat we uw connector hebben gevalideerd, zullen we u vragen om grondige tests uit te voeren.

  1. Volg de instructies in Uw connector testen tijdens certificering om een omgeving in de Preview-regio te maken ter voorbereiding op uw tests.

  2. Laat uw Microsoft-contactpersoon binnen een week weten dat u de test hebt voltooid, zodat we kunnen beginnen met de implementatie.

  3. Nadat de functionaliteit en inhoud van uw connector zijn gevalideerd door zowel Microsoft als uzelf, zullen we de connector klaarzetten voor implementatie in de preview-regio om te testen.

Stap 7: Wachten op implementatie

Nadat uw connector is gevalideerd voor het testen, implementeren we de connector in alle producten en regio's.

Belangrijk

Het duurt gemiddeld 7-10 werkdagen om de connector te implementeren. Dit is vereist, ongeacht de grootte of complexiteit van uw connector, of deze nu nieuw of een update is. Om de integriteit te beschermen wordt de connector onderworpen aan dezelfde validatietaken om functionaliteit en inhoud te testen die bij elke implementatie worden gevolgd.

We stellen u per e-mail op de hoogte met de namen van de regio's waarin de connector wordt geïmplementeerd, aangezien de implementatie naar regio's in stappen gebeurt. Als de implementatie vertraagd is of vastloopt, kunnen niet-Microsoft-uitgevers de status vinden in de Activiteitencontrole in de ISV-portal. Onafhankelijke uitgevers worden per e-mail op de hoogte gebracht.

Productie-implementatie

Onze connector-implementatieschema's voor productie starten op maandag- en woensdagochtend, PST/PDT. U moet Microsoft ten minste 24 uur van tevoren laten weten dat u klaar bent voor productie-implementatie, zodat wij uw connector kunnen opnemen in de volgende geplande implementatie. Niet-Microsoft-uitgevers kunnen ons hiervan op de hoogte stellen in via Activiteitencontrole in de ISV-portal. Onafhankelijke uitgevers kunnen hun Microsoft-contactpersoon op de hoogte stellen.

Regionale implementatie

De implementatie in verschillende regio's vindt plaats in een vooraf bepaalde dagelijkse volgorde. De regio's zijn:

  • Testen.
  • Preview in VS.
  • Azië, behalve Japan en India.
  • Europa, behalve VK.
  • Brazilië, Canada, Japan en India.
  • Australië, VK en VS.

Als uw connector bijvoorbeeld is gepland voor implementatie op maandag, wordt deze op dag 1 geïmplementeerd in de testregio. Vervolgens wordt deze op dag 2 geïmplementeerd in de Amerikaanse preview-regio. De implementatie wordt dagelijks voortgezet totdat de connector in alle zes regio's is geïmplementeerd.

De implementatie vindt niet plaats op vrijdag, zaterdag, zondag en Amerikaanse feestdagen.

Wanneer uw connector de certificering aan het voltooien is, nemen we contact met u op over een marketingmogelijkheid voor de connector op de Power Automate-blog.

Stap 8: Opties na implementatie verkennen

Hier zijn enkele opties die u kunt verkennen nadat uw connector is geïmplementeerd:

Controlelijst voordat u indient

Voordat u verdergaat met Uw connector indienen voor Microsoft-certificering, moet u ervoor zorgen dat:

Als u een niet-Microsoft uitgever bent (en geen onafhankelijke uitgever), wordt u gevraagd akkoord te gaan met onze partnerovereenkomst en geheimhoudingsverklaring wanneer u uw connector indient voor certificering door Microsoft. Als u deze voorwaarden en taal vóór de indiening wilt bekijken, kunt u contact opnemen met de contactpersoon van Microsoft.

Volgende stap

Uw connector indienen voor Microsoft-certificering