Proces certifikace ověřeného vydavatele
Tento proces je pro ověřené vydavatele (s výjimkou nezávislých vydavatelů). Pokud jste nezávislým vydavatelem, přejděte do části Proces certifikace nezávislého vydavatele.
Až dokončíte vývoj vlastního konektoru, podle těchto kroků ho připravte k certifikaci a vygenerujte soubory konektoru, které odešlete do společnosti Microsoft.
Poznámka
Tohle téma poskytuje informace o certifikaci vlastních konektorů v Azure Logic Apps, Power Automate a Power Apps. Před postupem podle kroků v tomto článku si přečtěte téma Certifikace konektoru a registrujte svůj vlastní konektor u společnosti Microsoft.
Základní pracovní postup certifikačního procesu
Následující vývojový diagram ukazuje základní pracovní postup certifikačního procesu. Očíslované kroky v tomto článku odpovídají pracovnímu postupu. Měly by vám poskytnout detaily, které potřebujete k dokončení certifikačního procesu.
Chcete-li rozšířené zobrazení vývojového diagramu, vyberte ikonu lupy vpravo dole.
Chcete-li získat podrobný přehled tohoto vývojového diagramu, přejděte na část Podrobný pracovní postup certifikace konektoru.
Krok 1: Registrace konektoru
K žádosti o certifikaci není nutné, abyste už měli dokončený vývoj vlastního konektoru. Chcete-li zahájit proces certifikace, zaregistrujte svůj konektor pro certifikaci vyplněním našeho registračního formuláře.
Do dvou pracovních dnů očekávejte e-mail od kontaktního pracovníka společnosti Microsoft, který:
- Bude rozumět vašemu vlastnímu konektoru.
- Zjistí více o pokroku při vývoji.
- Provede vás procesem certifikace.
Krok 2: Splňte požadavky na odeslání
Pro udržení vysokého standardu kvality a konzistence mezi našimi certifikovanými konektory má Microsoft sadu požadavků a pokynů, které musí váš vlastní konektor dodržovat pro certifikaci.
Pojmenujte svůj konektor
- Musí existovat a musí být v angličtině.
- Musí být jedinečný a rozlišitelný od jakéhokoli stávajícího názvu konektoru.
- Měl by být název vašeho produktu nebo organizace.
- Měl by vycházet z existujících vzorů pojmenování certifikovaných konektorů. Pro nezávislé vydavatele by název konektoru by měl vypadat dle vzoru Název konektoru (nezávislý vydavatel).
- Název nesmí být delší než 30 znaků.
- Nesmí obsahovat slova „API“, „Connector“ nebo žádný z našich názvů produktů Power Platform (například „Power Apps").
- Nemůže končit nealfanumerickým znakem, včetně návratu na začátek řádku, nového řádku nebo mezery.
Příklady
- Dobré názvy konektorů: „Azure Sentinel“, „Office 365 Outlook"
- Špatné názvy konektorů: „Azure Sentinel Power Apps Konektor","Office 365 Outlook API"
Napište popis svého konektoru
- Musí existovat a musí být v angličtině.
- Musí být bez gramatických a pravopisných chyb.
- Měl by stručně popsat hlavní účel a hodnotu nabízenou vaším konektorem.
- Nesmí být kratší než 30 znaků nebo delší než 500 znaků.
- Nesmí obsahovat žádné názvy produktů Power Platform (například „Power Apps").
Návrh ikony pro váš konektor
Tato část se nevztahuje na nezávislé vydavatele.
- Vytvořte logo s poměrem stran 1:1 v rozsahu 100 x 100 až 230 x 230 pixelů (bez zaoblených hran).
- Musí obsahovat neprůhledné, nebílé pozadí (#ffffff) a jinou než výchozí barvu (#007ee5), které odpovídá zadané barvě pozadí ikony.
- Musí být jedinečné pro jakoukoli jinou ikonu certifikovaného konektoru.
- Musí se odeslat ve formátu PNG jako "icon.png".
- Rozměry loga jsou nižší než 70 % pro výšku a šířku obrázku s konzistentním pozadím.
- Ujistěte se, že barva značky je platná hexadecimální barva a neměla by být bílá (#ffffff) ani výchozí (#007ee5).
Definování souhrnů a popisů operací a parametrů
- Musí existovat a musí být v angličtině.
- Musí být bez gramatických a pravopisných chyb.
- Souhrny operací a parametrů by měly být fráze, 80 znaků nebo kratší, a měly by obsahovat pouze alfanumerické znaky nebo závorky.
- Popisy operací a parametrů by měly být plné, popisné věty a měly by končit interpunkcí.
- Nesmí obsahovat žádné názvy produktů Microsoft Power Platform (například „Power Apps").
Definování přesných provozních reakcí
- Odpovědi operace definujte pomocí přesného schématu pouze u očekávaných odpovědí.
- Nepoužívejte výchozí odpovědi s přesnou definicí schématu.
- Zadejte platné definice schématu odpovědi pro všechny operace ve swaggeru.
- Prázdná schémata odpovědí nejsou povolena s výjimkou zvláštních případů, kdy je schéma odpovědi dynamické. To znamená, že ve výstupu se nezobrazí žádný dynamický obsah a tvůrci musí k analýze odpovědi použít JSON.
- Prázdné operace nejsou povoleny.
- Odstraňte prázdné vlastnosti, pokud nejsou vyžadovány.
Ověřte vlastnosti Swaggeru
- Ujistěte se, že "openapidefinition" je ve správně naformátovaném souboru JSON.
- Zajistěte, aby definice swaggeru odpovídala standardu OpenAPI 2.0 a rozšířenému standardu konektorů.
Ověřte parametry připojení
Ujistěte se, že vlastnost je aktualizována vhodnými hodnotami pro "UIDefinition" (zobrazované jméno, popis).
Pokud váš parametr připojení používá Základní ověřování, ujistěte se, že je JSON správně naformátován podle následujícího příkladu.
{ "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" } } } }
Pokud váš parametr připojení má APIKey jako ověřování, ujistěte se, že je JSON správně naformátován podle následujícího příkladu.
{ "api_key": { "type": "securestring", "uiDefinition": { "displayName": "YourApiKeyParameterLabel", "tooltip": "Provide your YourApiKeyParameterLabel tooltip text", "constraints": { "tabIndex": 2, "clearText": false, "required": "true" } } } }
Pokud váš parametr připojení má generický OAuth jako ověřování, ujistěte se, že je JSON správně naformátován podle následujícího příkladu.
{ "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 } }
Pokud má váš parametr připojení poskytovatele identity OAuth2, ujistěte se, že poskytovatel identity je ze seznamu podporovaných poskytovatelů OAuth2. Následuje příklad poskytovatele identity GitHub OAuth2:
{ "token": { "type": "oAuthSetting", "oAuthSettings": { "identityProvider": "github", "scopes": [ "scope1" ], "redirectMode": "GlobalPerConnector", "customParameters": {}, "clientId": "YourClientId" }, "uiDefinition": null } }
Pokud váš parametr připojení má Microsoft Entra ID jako ověřování, ujistěte se, že je JSON správně naformátován podle následujícího příkladu.
{ "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 } }
Vytváření kvalitních anglických jazykových řetězců
Konektory jsou lokalizovány jako součást lokalizace Power Automate; proto, když vyvíjíte konektor, kvalita anglických řetězců je klíčem ke kvalitě překladu. Zde je několik hlavních oblastí, na které je třeba se zaměřit při vytváření hodnot řetězců, které poskytnete.
Nezapomeňte spustit program kontroly pravopisu, abyste zajistili, že všechny hodnoty řetězce neobsahují typografické chyby. Pokud existuje nějaký neúplný anglický jazykový řetězec, výsledek překladu je neúplný nebo nesprávný v kontextu.
Ujistěte se, že věta je v úplném tvaru. Pokud věta není úplná, může to také vést k nižší kvalitě překladů.
Ujistěte se, že význam věty je jasný. Pokud je význam věty nejednoznačný, může to také způsobit nižší kvalitu nebo nesprávné překlady.
Ujistěte se, že souhrny, x-ms-souhrny a popisy jsou gramaticky správné. Nekopírujte je. Chcete-li zjistit, jak se zobrazují v produktu, přejděte na Vedení řetězce konektoru.
Pokud je to možné, vyhněte se složeným řetězcům modulu runtime. Místo toho použijte plně vytvořené věty. Zřetězené řetězce nebo věty znesnadňují překlad nebo mohou způsobit nesprávný překlad.
Pokud používáte zkratky, ujistěte se, že jsou zapsány velkými písmeny, aby byly jasně srozumitelné. Sníží se tak možnost záměny za typografickou chybu.
Řetězce ve formě CaMel (např. minimizeHighways nebo MinimizeHighways) jsou obvykle považovány za nepřeložitelné. Pokud chcete lokalizovat hodnotu řetězce, musíte opravit formu CaMel.
Krok 3: Spusťte Kontrolu řešení k ověření vašeho konektoru.
Kontrola řešení je mechanismus pro provádění statické analýzy, aby se zajistilo, že váš konektor splňuje standardy požadované společností Microsoft pro certifikaci. Přidejte svůj konektor do řešení v Power Automate nebo Power Apps a spusťte kontrolu řešení podle pokynů na stránce Ověření vlastního konektoru pomocí kontroly řešení.
V tomto videu se dozvíte, jak spustit kontrolu řešení:
Krok 4: Přidání metadat
Artefakty konektoru (soubory) musí obsahovat specifická metadata popisující konektor a jeho koncovou službu. Informace poskytované v metadatech jsou zveřejněny v naší dokumentaci ke konektoru a jsou veřejně přístupné všem uživatelům. Neposkytujte žádné soukromé ani důvěrné informace a pokud se vyskytnou nějaké problémy s poskytnutím těchto informací, informujte nás o tom prostřednictvím svého kontaktu se společností Microsoft. Chcete-li se dovědět, jak jsou metadata zdokumentována, navštivte některou ze stránek dokumentace specifických pro konektory v části Reference konektoru.
Krok 4a: Vlastnosti vydavatele a stackOwner
"vydavatel" je název vaší společnosti nebo organizace. Zadejte úplný název společnosti (například „Contoso Corporation“). Musí být v alfanumerickém formátu.
"stackOwner" je vlastnická společnost nebo organizace back-endového zásobníku služeb, ke kterému se konektor připojuje. Musí být v alfanumerickém formátu.
Vydavatel | Description | Příklad |
---|---|---|
Ověřeno | Vydavatel a stackOwner jsou stejní, pokud ISV nevytváří konektor jménem stackOwner. | "vydavatel": "Tesla", "stackOwner": "Tesla" |
Nezávislý | Musíte uvést vlastníka zásobníku a vlastníka vydavatele. | "vydavatel": "Nirmal Kumar", "stackOwner": "ITGlue" |
Umístění souboru: apiProperties.json
Chcete-li se dozvědět více, přejděte na Soubor vlastností API.
Syntax: Vlastnosti publisher a stackOwner existují jako vlastnosti nejvyšší úrovně v souboru apiProperties.json. Přidejte následující zvýrazněné řádky, jak je znázorněno. Ujistěte se, že zadáváte název vlastnosti a schéma přesně tak, jak je znázorněno.
Kód zobrazující červeně zvýrazněný blok definující kontaktní objekt. Tento blok musí být umístěn přímo pod popisem. Další blok, x-ms-connector-metadata, je také zvýrazněn červeně. Tento blok musí být umístěn přímo pod cestami: {}.
Krok 4c: Ukázka fragmentů kódu
Následující fragmenty kódu můžete použít ke zkopírování a zadání svých informací. Zajistěte, abyste fragmenty přidali do správných souborů na správných místech, jak je popsáno v předchozí části.
"publisher": "_____",
"stackOwner": "_____"
"contact": {
"name": "_____",
"url": "_____",
"email": "_____"
}
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "_____"
},
{
"propertyName": "Privacy policy",
"propertyValue": "_____"
},
{
"propertyName": "Categories",
"propertyValue": "_____;_____"
}
]
Poznámka
V používání vlastnosti stackOwner a našeho nástroje CLI Paconn existuje aktuální omezení. Další informace získáte v části Omezení v souboru README.
Krok 4d: Formátování souboru JSON a omezení
Ujistěte se, že jsou vaše vlastnosti správně zarovnány.
Vložte svůj JSON do Visual Studio Code. Neváhejte použít rozšíření, jako je kontrola pravopisu, a pluginy, jako jsou pluginy JSON.
Soubory Swagger by neměly být větší než 1 MB.
- Zvažte design vašeho konektoru, než jej začnete stavět. Vyhodnoťte, zda by měl být konektor rozdělen na dva (2) nebo více konektorů.
- Větší swagger soubory mohou způsobit zpoždění při použití konektoru.
Na platformě jsou například tři (3) různé konektory HubSpot.
Krok 4e: Ověření souborů vlastního konektoru
Spusťte paconn validate --api-def [Location of apiDefinition.swagger.json]
. Tento nástroj ověří definici konektoru a poskytne vám informace o případných chybách, které budete muset před odesláním opravit.
Pokud váš konektor používá typ ověřování OAuth, přidejte tyto povolené adresy URL pro přesměrování do své aplikace.
https://global.consent.azure-apim.net/redirect/{apiname}
https://global-test.consent.azure-apim.net/redirect/{apiname}
Krok 5: Příprava artefaktů konektoru
Tento krok by vám měl zabrat přibližně jeden týden.
Poznámka
- Před certifikací se ujistěte, že jste dodrželi specifikace a zajistili kvalitu konektoru. V opačném případě se certifikace zpozdí, protože vás budeme muset požádat o provedení změn.
- Poskytněte produkční verzi adresy URL hostitele. Zkušební, vývojářské a testovací adresy URL hostitele nejsou povoleny.
Do společnosti Microsoft odesíláte sadu souborů označovaných jako artefakty konektoru stažené pomocí nástroje rozhraní příkazového řádku poskytnutého společností Microsoft. Tento nástroj ověří váš konektor kvůli případným chybám při rozbití.
Chcete-li začít, postupujte následovně:
Nainstalujte nástroj CLI konektorů Microsoft Power Platform podle pokynů pokyny pro instalaci.
Zadáním následujícího příkazu na příkazovém řádku se přihlaste k platformě Microsoft Power Platform:
paconn login
. Podle pokynů se přihlaste pomocí procesu pro kód zařízení Microsoftu.Po ověření si stáhněte vlastní soubory konektoru:
- Spusťte
paconn download
. Zadáním příslušného čísla na příkazovém řádku vyberte prostředí, ve kterém se váš vlastní konektor nachází, a potom vyberte název vlastního konektoru.
Nástroj stáhne artefakty konektoru ve složce do umístění systému souborů, kde jste spustili příkaz
paconn
. V závislosti na typu vydavatele uvidíte různé artefakty:- Spusťte
Vydavatel | Artefakt |
---|---|
Ověřeno | apiDefinition.swagger.json apiProperties.json settings.json Ikona konektoru |
Nezávislý | apiDefinition.swagger.json apiProperties.json |
Jak ověření vydavatelé, tak nezávislí vydavatelé stahují apiProperties.json
ve svých artefaktech. Budete muset nastavit IconBrandColor v tomto souboru.
- Ověření vydavatelé: Nastavte iconBrandColor na barvu vaší značky v souboru apiProperties.
- Nezávislí vydavatelé: Nastavte iconBrandColor na "#da3b01" v souboru apiProperties.
Vytvoření artefaktu souboru Readme
Soubor Readme.md je nezbytný jak pro nezávislé vydavatele, tak pro ověřené vydavatele. Musíte vytvořit Readme.md soubor, abyste zdokumentovali funkce a funkčnost vašeho konektoru. Příklad dokumentace k zahrnutí naleznete na příkladu Readme.md. Podívejte se na další Readme.md soubory v našem úložišti GitHub, kde se dozvíte o psaní souboru Readme.md.
Pokud jste nezávislý vydavatel a váš konektor používá protokol OAuth, nezapomeňte uvést pokyny, jak získat přihlašovací údaje.
Tip
Známé problémy a omezení je skvělá sekce, kterou je třeba udržovat, aby vaši uživatelé měli aktuální informace.
Krok 6: Odešlete svůj konektor k nasazení
Během procesu odesílání otevíráte zdroj vašeho konektoru do našeho Úložiště konektorů Microsoft Power Platform.
Podle pokynů v části Odeslání konektoru společnosti Microsoft k certifikaci odešlete vlastní konektor na GitHub a certifikační portál.
Pokud jste ověřený vydavatel a používáte vlastní kód, budete muset odeslat soubor script.csx.
Jakmile odešlete žádost o přijetí změn do open-source úložiště, Microsoft nasadí a ověří váš konektor do jednoho až dvou týdnů. Pokud jsou vyžadovány aktualizace, vyčkejte jeden až dva týdny navíc.
**Pokud má váš konektor protokol OAuth, odešlete balíček v ISV Studio a získejte název API z žádosti o odeslání konektoru, abyste mohli aplikaci aktualizovat.
V rámci odeslání společnost Microsoft ověří váš konektor pomocí nástrojů CLA-bot, Swagger Validator a Breaking Change Detector. Pokud potřebujete vyřešit chyby se swaggerem, přejděte do části Oprava chyb nástroje Swagger Validator.
Krok 7: Očekávání ohledně testování provedeného ověřenými vydavateli
Po ověření vašeho konektoru vás požádáme o důkladné otestování.
Postupujte podle pokynů v části Otestujte konektor v certifikaci k vytvoření prostředí v oblasti Preview v rámci přípravy na testování.
Do jednoho týdne oznamte svému kontaktu společnosti Microsoft, že jste dokončili testování, abychom mohli začít s nasazením.
Poté, co Microsoft i vy ověří funkčnost a obsah vašeho konektoru, připravíme konektor pro nasazení v oblasti Preview k testování.
Krok 8: Čekání na nasazení
Po ověření konektoru k testování jej nasadíme ve všech produktech a oblastech.
Důležité
Nasazení konektoru trvá v průměru 3 až 4 týdny. Je to potřeba bez ohledu na velikost nebo složitost vašeho konektoru, ať už je nový nebo aktualizovaný. Aby byla zajištěna integrita, bude konektor podroben stejným úkolům ověřující funkčnost a obsah, které jsou prováděny při každém nasazení.
E-mailem vám oznámíme názvy oblastí, ve kterých bude konektor nasazen, protože nasazení do oblastí probíhá v krocích. Pokud dojde ke zpoždění nebo zamrznutí nasazení, mohou ověření vydavatelé najít stav v části Řízení aktivity v portálu ISV. Nezávislí vydavatelé budou informováni e-mailem.
Nasazení do provozu
Naše plány nasazení konektorů do provozu začínají v páteční rána, PST/PDT. Abychom mohli váš konektor zahrnout do dalšího plánovaného nasazení, musíte společnosti Microsoft oznámit, že jste připraveni na nasazení do provozu, alespoň 24 hodin předem. Ověření vydavatelé nás mohou upozornit v části Řízení aktivity v portálu ISV. Nezávislí vydavatelé mohou informovat své kontaktní osoby ve společnosti Microsoft.
Nasazení do oblasti
Nasazení do různých oblastí probíhá v předem stanoveném denním sledu. Oblasti jsou:
- Testování.
- US Preview.
- Asie kromě Japonska a Indie.
- Evropa kromě Spojeného království.
- Brazílie, Kanada, Japonsko a Indie.
- Austrálie, Spojené království a USA.
Pokud je například nasazení vašeho konektoru naplánováno na pondělí, 1. den je nasazen do oblasti testování. Poté se 2. den nasadí do oblasti Preview v USA. Nasazení pokračuje každý den, dokud nebude konektor nasazen do všech šesti oblastí.
Nasazení neprobíhá v sobotu, neděli a americké svátky.
Protože je pro váš konektor dokončována certifikace, zapojíme vás do marketingové příležitosti na blogu Power Automate.
Krok 9: Prozkoumejte možnosti po nasazení
Po nasazení konektoru můžete prozkoumat několik možností:
Telemetrii konektoru můžete kdykoli zobrazit na portálu ISV. Informace o stavu a použití vašeho konektoru najdete v části Získání klíčových postřehů o certifikovaném konektoru na portálu ISV.
Odešlete aktualizace konektoru. Další informace získáte v části Aktualizace certifikovaného konektoru.
Sledujte svůj konektor na komunitním diskusním fóru, kde uvidíte, zda se zákazníci potýkají s nějakými problémy nebo mají požadavky na funkce pro váš konektor.
Požádejte o odstranění značky Preview. Poté, co bude konektor nějakou dobu veřejně dostupný a splní určité požadavky, může mít nárok na přidělení značky obecná dostupnost. Tato značka ukazuje, že konektor je produkt připravený k provozu. Podrobné informace naleznete na Přesun konektoru z verze Preview do obecné dostupnosti.
Kontrolní seznam před odesláním
Před přechodem na krok Odešlete svůj konektor k certifikaci Microsoft, se ujistěte, že:
Váš konektor splňuje všechny stanovené standardy vytknuté v částech Krok 2: Splnění požadavků na odeslání a Krok 4: Přidání metadat.
V žádné z operací nechybí souhrn, popis ani informace o viditelnosti.
Vyzkoušeli jste svůj vlastní konektor, abyste zajistili, že operace fungují podle očekávání (alespoň 10 úspěšných hovorů na operaci).
V sekci testování v průvodci vlastním konektorem nedojde k žádným chybám běhu nebo ověření schématu.
Tip
Pokud jste ověřeným vydavatelem (a nikoli nezávislým vydavatelem), jste požádáni o souhlas s naší partnerskou smlouvou a smlouvou o mlčenlivosti, když se budete přihlašovat k certifikaci společnosti Microsoft. Pokud si před odesláním chcete tyto podmínky a jejich znění prostudovat, obraťte se na vaši kontaktní osobu v Microsoftu.
Další krok
Odeslání konektoru k certifikaci Microsoftu
Poskytnutí názorů
Velmi si vážíme vašich názorů na problémy s naší platformou konektorů nebo nových nápadů na funkce. Chcete-li poskytnout zpětnou vazbu, přejděte do části Odeslat problémy nebo získat pomoc s konektory a vyberte typ zpětné vazby.