Übersicht über Web-API für Portale
Die Web-API des Portals ermöglicht eine reichhaltigere Benutzererfahrung in Power Pages-Websites. Sie können die Web-API verwenden, um Vorgänge zum Erstellen, Lesen, Aktualisieren und Löschen aller Microsoft Dataverse-Tabellen von Ihren Webseiten aus durchzuführen. Sie können beispielsweise ein neues Konto erstellen oder einen Kontakt aktualisieren, ohne ein Formular oder ein mehrstufiges Formular mithilfe des Web-API des Portals zu verwenden.
Wichtig
- Ihre Power Pages-Websiteversion muss 9.3.3.x oder höher sein, damit dieses Feature funktioniert.
- Die Web-API für Portale ist zum Erstellen einer umfassenden Benutzerumgebung in Portalseiten konzipiert. Sie ist nicht für Dienste von Drittanbietern oder die Integration von Anwendungen optimiert. Die Verwendung der Web-API des Portals zur Integration mit anderen Power Pages Sites wird ebenfalls nicht unterstützt.
- Portalvorgänge mit der Web-API sind auf datenbezogene Tabellen beschränkt – zum Beispiel Konten, Kontakte oder Ihre benutzerdefinierten Tabellen. Konfigurieren von Tabellenmetadaten oder Portalkonfigurationstabellendaten – zum Beispiel, das Konfigurieren von Portaltabellen wie adx_contentsnippet, adx_entityform oder adx_entitylist – wird mit der Web-API für Portale nicht unterstützt. Eine vollständige Liste finden Sie unter Unterstützte Konfigurationstabellen weiter unten in diesem Thema.
- Die Portale-Web-API profitiert vom Server-seitigen Zwischenspeichern, so dass nachfolgende Aufrufe der Web-API schneller sind als die ersten Aufrufe. Beachten Sie, dass das Löschen des serverseitigen Caches des Portals zu einer vorübergehenden Leistungsverschlechterung führt.
- Für Portale-Web-API-Vorgänge ist eine Power Pages-Lizenz erforderlich. Beispielsweise werden Web-API-Aufrufe von anonymen Benutzern auf die Kapazität des anonymen Benutzers angerechnet. Web-API-Aufrufe von authentifizierten Benutzern (intern oder extern) werden nicht für Seitenaufrufe gezählt, erfordern jedoch entsprechende Kapazitätslizenzen des authentifizierten Benutzers. Weitere Informationen: Häufig gestellte Fragen zur Power Pages
Web-API-Vorgänge
Die Web-API für Portale bietet einen Teil der Funktionen für Dataverse-Vorgänge, die Sie mit der Dataverse-API ausführen können. Wir haben das API-Format so ähnlich wie möglich gehalten, um die Lernkurve zu verringern.
Anmerkung
Bei Web-API-Operationen wird zwischen Groß- und Kleinschreibung unterschieden.
In Power Pages verfügbare Web-API-Vorgänge
- Datensätze aus einer Tabelle lesen
- Erstellen eines Datensatzes in einer Tabelle
- Datensätze in einer Tabelle aktualisieren und löschen
- Tabellen assoziieren und disassoziieren
Anmerkung
Das Aufrufen von Aktionen und Funktionen mit Web-API von Portale wird nicht unterstützt.
Website-Einstellungen für die Web-API
Sie müssen die Website-Einstellung aktivieren, um die Web-API für Portale für Ihr Portal zu aktivieren. Sie können auch die Web-API auf Feldebene konfigurieren, die die Tabellenfelder festlegt, die mit der Portale-Web-API geändert werden können oder nicht.
Anmerkung
Verwenden Sie die Tabelle logischer Name für diese Einstellungen (z. B. Konto).
Website-Einstellungsname | Beschreibung |
---|---|
Webapi/<table name>/enabled | Aktiviert oder deaktiviert die Web-API für <Tabellenname>. Standard: False Gültige Werte: True , False |
Webapi/<table name>/fields | Definiert die durch Kommas getrennte Liste von Attributen, die mit der Web-API geändert werden können. Mögliche Werte: - Alle Attribute: * - Spezifische Attribute: attr1,attr2,attr3 Hinweis: Der Wert muss entweder ein Sternchen sein (*) oder eine durch Kommas getrennte Liste von Feldnamen. Wichtig: Dies ist eine obligatorische Website-Einstellung. Wenn diese Einstellung fehlt, wird der Fehler „Für diese Entität sind keine Felder festgelegt“ angezeigt. |
Webapi/error/innererror | Aktiviert oder deaktiviert InnerError. Standard: False Gültige Werte: True , False |
Webapi/<table name>/disableodatafilter | Aktiviert oder deaktiviert den OData-Filter. Standard: False Gültige Werte: True , False , weitere Informationen finden Sie unter Bekannte Probleme. Die Website-Einstellung ist in der Portalversion 9.4.10.74 oder später verfügbar. |
Anmerkung
Die Website-Einstellungen müssen auf Aktiv festgelegt sein, damit Änderungen wirksam werden.
Um beispielsweise die Web-API für die Anfragetabelle verfügbar zu machen, bei der authentifizierte Benutzer Erstellungs-, Aktualisierungs- und Löschvorgänge für diese Entität ausführen dürfen, werden die Website-Einstellungen in der folgenden Tabelle angezeigt.
Website-Einstellungsname | Website-Einstellungswert |
---|---|
Webapi/incident/enabled | Wahr |
Webapi/incident/fields | attr1, attr2, attr3 |
Sicherheit mit der Web-API für Portale
Sie können die datensatzbasierte Sicherheit für einzelne Datensätze in Portalen mithilfe von Tabellenberechtigungen konfigurieren. Die Portale-Web-API greift auf Tabellendatensätze (Entitäten) zu und folgt den Tabellenberechtigungen, die den Benutzern über die zugehörige Web-Rolle erteilt wurden.
Sie können Spaltenberechtigungen konfigurieren, um weitere Rechte für individuelle Spalten innerhalb einer Tabelle weiter zu definieren, während die Web-API des Portals verwendet wird.
Authentifizieren von Anforderungen an Web-API für Portale
Sie müssen keinen Authentifizierungscode einfügen, da die Authentifizierung und Autorisierung von der Anwendungssitzung verwaltet wird. Alle Web-API-Aufrufe müssen ein CSRF-Token (webiteübergreifende Anforderungsfälschung) enthalten.
Verwenden von EntitySetName
Bei Bezugnahme auf Dataverse Tabellen mit der Web-API des Portals in Ihrem Code, müssen Sie EntitySetName verwenden, um beispielsweise auf die Konto Tabelle zuzugreifen, verwendet Sie die Codesyntax den EntitySetName von Konten ; /_api/accounts()
.
Anmerkung
Verwenden Sie die Tabelle Logischer Name für Websiteeinstellungen (zum Beispiel, Konto).
Sie können den EntitySetName bestimmter Tabellen bestimmen, indem Sie die folgenden Schritte ausführen:
Zu https://make.powerapps.com wechseln
Wählen Sie die Dataverse-Registerkarte im Seitenbereich und die Tabelle aus.
Wählen Sie die ... (Befehlsoption) und dann Erweitert, Tools und Satzname kopieren aus, um den EntitySetName der Tabelle in die Zwischenablage zu kopieren.
Datenschutzgesetze und -vorschriften
Alle Abfrage-Header enthalten eine Kontakt-ID, die zu Prüfzwecken übergeben wird. Für einen anonymen Benutzer wird dies als null
übergeben.
Wenn die Überwachungsprotokollierung aktiviert ist, kann ein Benutzer alle Überwachungsereignisse im Office 365-Überwachungsprotokoll anzeigen.
Weitere Informationen:
Aktivieren und verwenden Sie die Aktivitätsprotokollierung
Exportieren, konfigurieren und betrachten Sie Datensätze des Audit-Protokolls
Nicht unterstützte Konfigurationstabellen
Die Portale-Web-API kann nicht für die folgenden Konfigurationstabellen verwendet werden:
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
Bekannte Probleme
Benutzende erhalten einen CDS-Fehler, wenn sie eine GET
-Web-API-Anforderung für Tabellen aufrufen, die mehrere Ebenen von 1:N- oder N:N-Tabellenberechtigungen haben, wenn die Bereiche Übergeordnet, Kontact oder Konto der Abfrage zusätzliche Bedingungen hinzufügen.
Um dieses Problem zu beheben, wird die Verwendung von FetchXML in der OData-Abfrage empfohlen.
Legen Sie alternativ die Website-Einstellung Webapi/<table name>/disableodatafilter auf True
fest.
Wichtig
Das Ändern der Website-Einstellung Webapi/<table name>/disableodatafilter auf True
kann zu einer geringeren Leistung bei Web-API-GET
-Aufrufen führen.
Die Website-Einstellung ist in der Portalversion 9.4.10.74 oder später verfügbar.
Nächster Schritt
Daten über die Portale-Web-API abfragen