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 funkció működéséhez a webhely verziójának 9.3.3.x vagy újabb verziójúnak kell lennie.
- 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 a cikk későbbi, nem támogatott konfigurációs táblázataiban találja .
- 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. A portál kiszolgálóoldali gyorsítótárának törlése átmeneti teljesítménycsökkenést okoz.
- 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ő) által kezdeményezett webes API-hívások nem számítanak bele az oldalmegtekintésekbe, de megfelelő hitelesített felhasználói kapacitáslicencekre van szükség. 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. Az API formátumot a lehető leghasonlóbbnak tartottuk a tanulási görbe csökkentése érdekében.
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
- Tábla rekordjainak frissítése és törlése
- Táblák társítása és társításának megszüntetése
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/<tábla neve>/engedélyezve | Engedélyezi vagy letiltja a webes API-t a következő entitáshoz: <table name>. Alapértelmezett: False Érvényes értékek: True, False |
| Webapi/<tábla neve>/mezői | 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: * - Speciális attribútumok: attr1,attr2,attr3 Megjegyzés: Az értéknek csillagnak (*) vagy mezőnevek vesszővel elválasztott listájának kell lennie. Fontos: Ez a beállítás kötelező webhelybeállítás. Ha ez a beállítás hiányzik, a következő hibaüzenet jelenik meg: "Nincs mező definiálva ehhez az entitáshoz." |
| Webapi/hiba/innererror | Engedélyezi vagy letiltja az InnerError elemet. Alapértelmezett: False Érvényes értékek: True, False |
| Webapi/<tábla neve>/disableodatafilter | Engedélyezi vagy letiltja az OData szűrőt. Alapértelmezett: False Érvényes értékek: True, False További információért tekintse meg az ismert problémákat . 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/incidens/mezők | 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
Nem kell hitelesítési kódot megadnia, mert az alkalmazás-munkamenet kezeli a hitelesítést és az engedélyezést. 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-ját használó táblákra Dataverse hivatkozik, az EntitySetName nevet kell használnia, például a partnertábla eléréséhez a kód szintaxisa a fiókok EntitySetName nevéthasználja; /_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
Minden kérelemfejléc naplózási célokra átadott kapcsolattartó-azonosítót használ. Névtelen felhasználó esetén ez az érték a következőként lesz átadva 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égnaplózás engedélyezése és használata
Auditnapló-bejegyzések 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 és sok közötti vagy több-többtáblaengedéllyel rendelkeznek, amikor a Parental, ** a Contact vagy a Partner hatókör további feltételeket ad a lekérdezéshez.
A probléma megoldásához az OData-lekérdezésben ajánlott FetchXML megoldás használata.
Másik lehetőségként állítsa be a Webapi/<table name>/disableodatafilter webhelybeállítást True értékre.
Fontos
A Webapi/table name /disableodatafilter<>webhelybeállítás módosítása lassabb teljesítményt eredményezhet a webes API-hívásoknál True . GET
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-jával