Erabili Power Apps egiaztatzailea webaren API

Artikulua
05/01/2024

Power Apps egiaztatzailearen web APIak analisi estatikoko egiaztapenak egin ditzakeen pertsonalizazioen eta hedapenen aurkako mekanismoa eskaintzen du Microsoft Dataverse plataforman. Garatzaileek analisi-egiaztapen estatiko aberatsak egin ditzakete soluzioetan eta jardunbide gomendatu multzo bat dute arazoen ereduak bizkor identifikatzeko. Zerbitzua logika eskaintzen du irtenbide egiaztatzailearen ezaugarria herrian Power Apps egile ataria automatizazioaren zati gisa sartzen da aurkeztutako eskabideak AppSource. Modu honetan zerbitzuarekin zuzenean interakzionatzeak lokal-en (onartutako bertsio guztiak) eta lineako inguruneen barnean dauden irtenbideak aztertzeko aukera ematen du.

PowerShell kodearen egiaztatzaile-zerbitzua erabiltzeari buruzko informazio gehiago lortzeko, ikus PowerShell erabiliz soluzioekin lan egin.

Oharra

Ren erabilera Power Apps egiaztatzaileak ez du bermatzen irtenbide inportazioak arrakasta izango duenik. Soluzioaren aurka egindako analisi estatikoen egiaztapenek ez dakite helmugako ingurunearen egoera konfiguratua eta inportazioen arrakasta inguruneko beste irtenbide edo konfigurazio batzuen menpe egon daiteke.

Planteamendu alternatiboak

Web APIekin maila baxuenean elkarreragiteko moduari buruzko xehetasunak irakurri aurretik, kontuan hartu gure PowerShell modulua, Microsoft.PowerApps.Checker.PowerShell erabiltzea ordez. Guztiz onartzen den tresna bat da, PowerShell Gallery-n eskuragarri dagoena. Oraingo murrizketa Windows PowerShell behar duela da. Baldintza hori bete ezin bada, APIekin zuzenean elkarreragina da hurbilketarik onena.

Erabiltzen hastea

Garrantzitsua da konponbidearen analisiak prozesu luzea ekar dezakeela. Normalean hirurogei (60) segundo eta bost (5) minutu baino gehiago iraun ditzake hainbat faktoreren arabera, hala nola pertsonalizazioen eta kodearen kopurua, tamaina eta konplexutasuna. Analisi-fluxua pauso anitz eta asinkronikoa da, lanaren osaketa kontsultatzeko erabiltzen ari den estatus APIarekin hasita. Analisi baterako fluxua adibide hau da:

Lortu OAuth token bat
Deia igo (fitxategi bakoitzean paraleloan)
Deien analisia (azterketa lana hasten du)
Deien egoera bukatu arte (deien artean eten bat bukatzen da amaiera seinalatu arte edo atalasak betetzen badira)
Deskargatu emandako SAS URI-ren emaitzak

Aldakuntza batzuk hauek dira:

Sartu arauaren edo arauen bilaketa aurrez aurreko urrats gisa. Hala ere, zertxobait azkarragoa izango litzateke konfiguratutako edo gogor kodetutako arau-kode ID batean pasatzea. Zure beharrak asetzen dituen erregeleta bat erabiltzea gomendatzen da.
Kargatzeko mekanismoa ez erabiltzea aukera dezakezu (ikusi igoera mugak direla eta).

Baldintza hauek zehaztu behar dituzu:

Zein geografia?
Zein bertsio?
Zein arau eta arau?
Zein da zure maizter IDa?

Ikusi artikulu hauek banakako APIei buruzko dokumentazioa lortzeko:

Berreskuratu arauen zerrenda
Berreskuratu arauen zerrenda
Fitxategiak kargatu
Aztertu azterketa
Egiaztatu analisiaren egoera zein den

Zehaztu geografia bat

Power Apps egiaztapen-zerbitzuarekin elkarreragiten duzunean, fitxategiak Azure-n gordetzen dira aldi baterako sortzen diren txostenekin batera. Geografiako API zehatz bat erabiliz, datuak non gordetzen diren kontrolatu dezakezu. Geografia amaierako eskaerak eskualdeko instantzia batera bideratzen dira errendimendu onenean oinarrituta (eskatzailearekiko latentzia). Eskaera eskualdeko zerbitzu instantzia batean sartu ondoren, tratamendu eta datu iraunkor guztiak eskualde jakin horretan geratzen dira. API-erantzun batzuek eskualdeko instantzia URLak itzultzen dituzte ondorengo eskaeretarako, azterketa-lan bat eskualde jakin batera bideratzen denean. Geografia bakoitzak zerbitzuaren bertsio desberdina izan dezake une bakoitzean zabalduta. Zerbitzu-bertsio desberdinen erabilera etapa anitzeko inplementazio-prozesu seguruari zor zaio, bertsio osoa bateragarritasuna ziurtatzen duena. Hortaz, analisi-bizitzako zikloan API dei bakoitzerako geografia bera erabili beharko litzateke eta exekuzio-denbora orokorra murriztu ahal izango da, datuek ez baitituzte hariaren gainetik hain urrun bidaiatu beharko. Hauek dira erabilgarri dauden geografiak:

Azure datu-gunea	Izena	Eremu geografikoa	Oinarria URI
Publikoa	Aurrebista	Estatu Batuak	unitedstatesfirstrelease.api.advisor.powerapps.com
Publikoa	Ekoizpena	Estatu Batuak	unitedstates.api.advisor.powerapps.com
Publikoa	Ekoizpena	Europa	europe.api.advisor.powerapps.com
Publikoa	Ekoizpena	Asia	asia.api.advisor.powerapps.com
Publikoa	Ekoizpena	Australia	australia.api.advisor.powerapps.com
Publikoa	Ekoizpena	Japonia	japan.api.advisor.powerapps.com
Publikoa	Ekoizpena	India	india.api.advisor.powerapps.com
Publikoa	Ekoizpena	Kanada	canada.api.advisor.powerapps.com
Publikoa	Ekoizpena	Hego Amerika	southamerica.api.advisor.powerapps.com
Publikoa	Ekoizpena	Erresuma Batua	unitedkingdom.api.advisor.powerapps.com
Publikoa	Ekoizpena	Frantzia	france.api.advisor.powerapps.com
Publikoa	Ekoizpena	Alemania	germany.api.advisor.powerapps.com
Publikoa	Ekoizpena	Arabiar Emirerri Batuak	unitedarabemirates.api.advisor.powerapps.com
Publikoa	Ekoizpena	Suitza	switzerland.api.advisor.powerapps.com
Publikoa	Ekoizpena	Hego Afrika	southafrica.api.advisor.powerapps.com
Publikoa	Ekoizpena	Hego Korea	korea.api.advisor.powerapps.com
Publikoa	Ekoizpena	Norvegia	norway.api.advisor.powerapps.com
Publikoa	Ekoizpena	Singapur	singapore.api.advisor.powerapps.com
Publikoa	Ekoizpena	Suedia	sweden.api.advisor.powerapps.com
Publikoa	Ekoizpena	US Government	gov.api.advisor.powerapps.us
Publikoa	Ekoizpena	US Government L4	high.api.advisor.powerapps.us
Publikoa	Ekoizpena	US Government L5 (DOD)	mil.api.advisor.appsplatform.us
Publikoa	Ekoizpena	Txina operatuta 21Vianet	china.api.advisor.powerapps.cn

Oharra

Aukeratu aurrebistako geografia erabiltzea lehenago azken aldaketak eta aldaketak sartzeko. Dena den, kontuan izan aurrebista Estatu Batuetako Azure eskualdeak soilik erabiltzen dituela.

Bertsio-kontrola

Beharrezkoa ez den arren, gomendatzen da api-bertsioaren kontsulta-katearen parametroa nahi den API bertsioarekin sartzea. Uneko APIaren bertsioa 2.0 da arau multzo eta arauetarako eta 1.0 gainerako eskaera guztietarako. Adibidez, arau multzo hau 2.0 API bertsioa erabiltzea zehazten duen HTTP eskaera da:

https://unitedstatesfirstrelease.api.advisor.powerapps.com/api/ruleset?api-version=2.0

Ematen ez bada, APIaren azken bertsioa erabiltzen da lehenespenez. Bertsio-zenbaki esplizitua erabiltzea gomendatzen da, bertsioa handitzen baita aldaketa aldaketak sartzen badira. Bertsioaren zenbakia eskaeran zehazten bada, geroko bertsioetan (zenbakizko handiagoak) bateragarritasun atzeko laguntza mantenduko da.

Arauak eta arauak

Power Apps zuzentzaileak exekutatzen direnean arauen zerrenda behar du. Arau horiek arau indibidualak edo arauak taldekatzeko moduan eman daitezke arau sorta. Arau multzo bat arau talde bat zehazteko modu egokia da, arau bakoitza banan-banan zehaztu beharrean. Adibidez, irtenbide egiaztatzailearen funtzioak izendatutako arau bat erabiltzen du Irtenbide egiaztatzailea. Arau berriak gehitzen edo kentzen diren heinean, zerbitzuak automatikoki sartzen ditu aldaketa hauek kontsumitzaileen aplikazioak inolako aldaketarik behar izan gabe. Arauen zerrenda goian deskribatu bezala automatikoki aldatzea eskatzen baduzu, arauak banaka zehaztu daitezke. Arauek arau bat edo gehiago izan ditzakete mugarik gabe. Arau bat ez da inolako arauetan edo erregeletan egon. Arau guztien zerrenda lor dezakezu API honetara deituz: [Geographical URL]/api/ruleset. Amaiera puntu honek autentifikazioa behar du orain.

Soluzio-egiaztatzailearen araua

Irtenbide egiaztatzaileen araudiak positibo faltsuak izateko aukera mugatuak dituen arau eragin handiko multzoa dauka. Lehendik dagoen soluzio baten aurka analisia egiten baduzu, gomendagarria da arau-multzo honekin hastea. Arau multzo hau soluzio-egiaztapenaren funtzioak erabiltzen du.

AppSource ziurtagiriaren araudia

Eskabideak argitaratzean AppSource, zure aplikazioa ziurtatu behar duzu. Argitaratutako eskaerak AppSource kalitate handiko estandarra bete behar dute. AppSource Ziurtagiri-arau multzoak soluzio-egiaztapenaren arau-multzoaren parte diren arauak ditu, baita dendan kalitate handiko aplikazioak soilik argitaratzen direla ziurtatzeko beste arau batzuk ere. AppSource Zurtagiriaren arau batzuk positibo faltsuak izateko joera handiagoa dute eta baliteke arreta gehiago behar izatea ebazteko.

Aurkitu zure maizterren NANa

Zure maizteraren IDa token bat eskatzen duten APIekin elkarreragiteko beharrezkoa da. Zerbaiti erreferentzia egin Artikulu hau maizterren NANa lortzeko xehetasunak lortzeko. PowerShell komandoak maizter IDa berreskuratzeko ere erabil ditzakezu. Hurrengo adibidean AzureAD moduluan cmdlet-ak aplikatzen dira.

# Login to Microsoft Entra ID as your user
Connect-AzureAD

# Establish your tenant ID
$tenantId = (Get-AzureADTenantDetail).ObjectId

Maizter IDa balioa da ObjectId itzultzen diren ondasunak Get-AzureADTenantDetail. Cmdlet irteerako Connect-AzureAD cmdlet erabiliz saioa hasi ondoren ere ikus dezakezu. Kasu honetan, TenantId izena izango du.

Autentifikazioa eta baimena

Arauak eta arau multzoak kontsultatzeko ez da OAuth tokenik behar, baina gainerako API guztiek behar dute tokena. APIak baimen aurkikuntza onartzen dute token bat eskatzen duten APIetako edozein deituz. Erantzuna 401 baimenik gabeko HTTP egoera-kode bat da, WWW-Authenticate goiburuarekin, baimen URIarekin eta baliabide IDarekin. Zure maizter IDa ere eman beharko zenioke x-ms-tenant-id goiburua. Ikus Power Apps Checker autentifikazioa eta baimena informazio gehiago lortzeko. API eskaera batetik itzultzen den erantzunaren goiburuaren adibidea da honakoa:

WWW-Authenticate →Bearer authorization_uri="https://login.microsoftonline.com/0082fff7-33c5-44c9-920c-c2009943fd1e", resource_id="https://api.advisor.powerapps.com/"

Informazio hori lortu ondoren, Microsoft Authentication Library (MSAL) edo tokena eskuratzeko beste mekanismoren bat erabiltzea aukera dezakezu. Hau C# eta MSAL .NET liburutegia erabiliz nola egin daitekeen erakusten duen adibidea da:

// Substitute your own environment URL here.
string resource = "https://<env-name>.api.<region>.dynamics.com";

// Example Microsoft Entra app registration.
// For your custom apps, you will need to register them with Microsoft Entra ID yourself.
// See https://docs.microsoft.com/powerapps/developer/data-platform/walkthrough-register-app-azure-active-directory
var clientId = "51f81489-12ee-4a9e-aaae-a2591f45987d";
var redirectUri = "http://localhost"; // Loopback required for the interactive login.

var authBuilder = PublicClientApplicationBuilder.Create(clientId)
    .WithAuthority(AadAuthorityAudience.AzureAdMultipleOrgs)
    .WithRedirectUri(redirectUri)
    .Build();
var scope = resource + "/.default";
string[] scopes = { scope };

AuthenticationResult tokenResult =
     await authBuilder.AcquireTokenInteractive(scopes).ExecuteAsync();

Lan-kode osoa ikusteko, ikusi Web APIa QuickStart adibidea.

Tokena eskuratu ondoren, eskaeraren bizi-zikloko hurrengo deiei token bera ematea gomendatzen da. Hala ere, eskaera gehiagok segurtasun arrazoiengatik token berri bat eskuratzea bermatu dezake.

Garraio segurtasuna

Enkriptazio onena lortzeko, egiaztatzaile zerbitzuak Transport Layer Security (TLS) 1.2 edo berriagoa erabiliz soilik onartzen ditu komunikazioak. .NET-en TLS-en inguruko jardunbide egokiei buruzko informazioa lortzeko, ikus Transport Layer Security (TLS) .NET Framework-rekin jardunbide egokiak.

Txostenaren formatua

Irtenbideen analisiaren emaitza txosten bat edo gehiago biltzen dituen zip fitxategia da JSON formatu normalizatuan. Txostenaren formatua analisi estatikoko emaitzen trukaketa-formatuan (SARIF) aipatutako analisi estatikoko emaitzetan oinarrituta dago. SARIF dokumentuak ikusteko eta elkarreragiteko tresnak eskuragarri daude. Honi erreferentzia webgune xehetasunetarako. Zerbitzuak OASIS estandarrarenren bigarren bertsioa erabiltzen du.

Ikusi ere