A Portálok webes API áttekintése
A portálok webes API-val teljesebb felhasználói élmény biztosítható a Power Pages-webhelyeken. A webes API segítségével műveleteket hozhat létre, olvashat, frissíthet és törölhet az összes Microsoft Dataverse-táblában a weboldalakról. Létrehozhat például új partnert vagy frissíthet egy kapcsolattartót űrlap vagy többlépéses űrlap használata nélkül, ha a portál webes API-ját használja.
Fontos
- A Power Pages-webhelyverziónak 9.3.3.x-nek vagy újabbnak kell lennie, hogy ez a funkció működjön.
- A Portálok webes API-t úgy alakítottuk ki, hogy teljesebb felhasználói élményt lehessen vele biztosítani a portálok oldalain. Nincs külső felek szolgáltatásaihoz vagy az alkalmazások integrálására optimalizálva. A portálok web API-jának használata más Power Pages-webhelyekkel való integrációra szintén nem támogatott.
- A portálok webes API-műveletei csak az adatokhoz kapcsolódó táblákra korlátozottak – például partner, kapcsolattartók vagy egyéni táblákra. A táblametaadatok vagy a portálkonfigurációs táblaadatok konfigurálása – például a portáltáblák (mint az adx_contentsnippet, adx_entityform vagy adx_entitylist) konfigurálása – nem támogatott a portálok webes API-val. A teljes listát lásd a nem támogatott konfigurációs táblák szakaszban a témakör későbbi részében.
- A Portálok webes API kihasználja a kiszolgálóoldali gyorsítótárazás előnyei, így a webes API későbbi meghívásai gyorsabbak az első hívásoknál. Ne feledje, hogy a portál kiszolgálóoldali gyorsítótárazásának törlése ideiglenes teljesítménycsökkenést okozhat.
- A portálok webes API-műveleteihez Power Pages-licenc szükséges. A névtelen felhasználók által készített webes API-hívásokat például a rendszer a névtelen felhasználók kapacitásába számítja. A hitelesített felhasználók (belső vagy külső) webes API-hívásait nem számítja bele a rendszer az oldalnézetekbe, hanem a megfelelő hitelesített felhasználói kapacitási licenceket igénylik. További információ: Power Pages licencelés GYIK
Webes Api-műveletek
A Portálok webes API a Dataverse API használatával megvalósítható Dataverse-műveletekhez nyújt szolgáltatásokat. A lehető legkevesebbet módosítottunk az API formátumán, hogy mielőbb el lehessen sajátítani a használati módot.
Feljegyzés
A webes API-műveletek megkülönböztetik a kis- és nagybetűket.
A Power Pages szolgáltatásban elérhető webes API-műveletek
- Rekordok olvasása táblából
- Rekord létrehozása táblában
- Rekordok frissítése és törlése táblában
- Táblák társítása és társításának megszüntetése
Feljegyzés
Műveletek és függvények hívása a portálok webes API használatával nem támogatott.
A webes API webhelybeállításai
Ha engedélyezni szeretné a portáljához a Portálok webes API-t, engedélyeznie kell a webhelybeállításokat. Ezenkívül konfigurálhatja azt a mezőszintű webes API-t, amely a portál webes API-val módosítható vagy nem módosítható táblamezőket határozza meg.
Feljegyzés
A beállításokhoz használja a tábla logikai nevét (például fiók).
| Webhelybeállítás neve | Adatfolyam leírása |
|---|---|
| Webapi/<table name>/enabled | Engedélyezi vagy letiltja a webes API-t a következő entitáshoz: <table name>. Alapértelmezett: False Érvényes értékek: TrueFalse |
| Webapi/<table name>/fields | A webes API-val módosítható attribútumok vesszővel tagolt listáját határozza meg. Lehetséges értékek: - Minden attribútum: * - Bizonyos attribútumok: attr1,attr2,attr3 Megjegyzés: az értéknek vagy csillagnak (*) vagy mezőnevek vesszővel tagolt listájának kell lennie. Fontos: Ez kötelező webhely-beállítás. Ha ez a beállítás hiányzik, a következő hibaüzenet jelenik meg: „Nincsenek mezők definiálva ehhez az entitáshoz”. |
| Webapi/error/innererror | Engedélyezi vagy letiltja az InnerError elemet. Alapértelmezett: False Érvényes értékek: TrueFalse |
| Webapi/<table name>/disableodatafilter | Engedélyezi vagy letiltja az OData szűrőt. Alapértelmezett: False Érvényes értékek: True, False. További információkért lásd az ismert problémákkal foglalkozó témakört. A webhelybeállítás a 9.4.10.74-es vagy újabb portálverzióban érhető el. |
Feljegyzés
A változtatások érvénybe léptetéséhez a webhely beállításait Aktív értékre kell állítani.
Például ha fel szeretné venni a webes API-t az Eset táblához, ahol a hitelesített felhasználók számára engedélyezett a létrehozási, frissítési és törlési műveletek végrehajtása ezen az entitáson, a webhely beállításai a következő táblázatban láthatók.
| Webhelybeállítás neve | Webhelybeállítás értéke |
|---|---|
| Webapi/incidens/engedélyezve | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
A portálok webes API biztonsági szolgáltatásai
A rekordalapú biztonságot a portálok egyes rekordjai számára táblajogosultságok segítségével konfigurálhatja. A portálok webes API-ja hozzáfér a táblarekordokhoz (entitásrekordokhoz), és követi a társított webes szerepkör segítségével a felhasználóknak adott táblaengedélyeket.
Az oszlopengedélyek konfigurálhatóak, hogy a portálok webes API használata közben tovább definiálja a tábla egyes oszlopainak jogosultságait.
A portálok webes API-kérések hitelesítése
A hitelesítési kódot nem kell felvenni, mert a hitelesítést és az engedélyezést az alkalmazási munkamenet kezeli. A webes API összes hívásának tartalmaznia kell a webhelyközi kérések hamisításának (CSRF) kódját.
Az EntitySetName használata
Amikor a kódban a portálok webes API-t használó Dataverse-táblákra hivatkozik, az EntitySetName nevet kell használnia például a fiók táblához való hozzáféréshez, a kód szintaxisa a fiókok EntitySetName fájlját fogja használni; /_api/accounts().
Feljegyzés
A webhelybeállításokhoz használja a tábla logikai nevét (például fiók).
A következő lépésekkel meghatározhatja az adott táblák EntitySetName értékét:
A https://make.powerapps.com megnyitása
Válassza ki a Dataverse lapot az oldalpanelen, majd válassza ki a táblát.
Válassza a ... (Parancsok) lehetőséget, majd válassza a Speciális, Eszközök és a Készlet másolása parancsot a tábla EntitySetName elemének vágólapra másolásához.
Adatvédelmi jogszabályok és rendeletek
Az összes kérésfejlécben megtalálható a naplózási célra átadott kapcsolattartói azonosító. Névtelen felhasználó esetén az átadott érték null.
Ha az auditnaplózás engedélyezve van, a felhasználó láthatja az összes naplózási eseményt az Office 365 auditnaplójában.
További információ:
Tevékenység naplózásának engedélyezése és használata
Az auditnaplók rekordjainak exportálása, konfigurálása és megtekintése
Nem támogatott konfigurációs táblák
A portálok webes API-ja nem használható a következő konfigurációs táblákhoz:
adx_contentaccesslevel
adx_contentsnippet
adx_entityform
adx_entityformmetadata
adx_entitylist
adx_entitypermission
adx_entitypermission_webrole
adx_externalidentity
adx_pagealert
adx_pagenotification
adx_pagetag
adx_pagetag_webpage
adx_pagetemplate
adx_portallanguage
adx_publishingstate
adx_publishingstatetransitionrule
adx_publishingstatetransitionrule_webrole
adx_redirect
adx_setting
adx_shortcut
adx_sitemarker
adx_sitesetting
adx_urlhistory
adx_webfile
adx_webfilelog
adx_webform
adx_webformmetadata
adx_webformsession
adx_webformstep
adx_weblink
adx_weblinkset
adx_webnotificationentity
adx_webnotificationurl
adx_webpage
adx_webpage_tag
adx_webpageaccesscontrolrule
adx_webpageaccesscontrolrule_webrole
adx_webpagehistory
adx_webpagelog
adx_webrole_systemuser
adx_website
adx_website_list
adx_website_sponsor
adx_websiteaccess
adx_websiteaccess_webrole
adx_websitebinding
adx_websitelanguage
adx_webtemplate
Ismert problémák
A felhasználók CDS-hibát kapnak, ha webes API-kérést hívnak meg GET olyan táblákhoz, amelyek több 1-től sokhoz vagy sokhoz és több-sok táblaengedélyekkelrendelkeznek, amikor a Parental , a Contact vagy a Partner hatókör további feltételeket ad hozzá a lekérdezéshez.
A probléma megoldásához az ajánlott megoldás a FetchXML használata az OData lekérdezésben.
Másik lehetőségként állítsa be a Webapi/<table name>/disableodatafilter webhelybeállítást True értékre.
Fontos
Ha módosítja a Webapi/<table name>/disableodatafilter webhelybeállítást True értékre, az lassíthatja a webes API GET hívásainak teljesítményét.
A webhelybeállítás a 9.4.10.74-es vagy újabb portálverzióban érhető el.
Következő lépés
Adatok lekérdezése portálok webes API-val