Ü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 z. B. ein neues Konto erstellen oder einen Kontakt aktualisieren, ohne ein Formular oder ein mehrstufiges Formular zu verwenden, indem Sie die Web-API für Portale verwenden.

Die Web-API verwendet die /_api Route (z. B https://yoursite.powerappsportals.com/_api/accounts. ) und folgt einem RESTful-Muster, das der Dataverse-Web-API ähnelt.

Wichtig

  • 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 Portalweb-API zur Integration in andere Power Pages Websites wird nicht unterstützt.
  • Portalvorgänge mit der Web-API sind auf datenbezogene Tabellen beschränkt – zum Beispiel Konten, Kontakte oder Ihre benutzerdefinierten Tabellen. Das Konfigurieren von Tabellenmetadaten oder Portalkonfigurationstabellendaten, z. B. das Konfigurieren von Portaltabellen wie adx_contentsnippet, adx_entityform oder adx_entitylist, wird nicht mithilfe der Portalweb-API unterstützt. Eine vollständige Liste finden Sie in den nicht unterstützten Konfigurationstabellen weiter unten in diesem Artikel.
  • Die Portale-Web-API profitiert vom Server-seitigen Zwischenspeichern, so dass nachfolgende Aufrufe der Web-API schneller sind als die ersten Aufrufe. Das Löschen des serverseitigen Caches des Portals führt zu einer vorübergehenden Leistungsverschlechterung.
  • Portals-Web-API-Vorgänge erfordern eine Power Pages-Lizenz. Web-API-Aufrufe von anonymen Benutzern zählen beispielsweise zur Kapazität anonymer Benutzer. Web-API-Aufrufe von authentifizierten Benutzern (intern oder extern) zählen nicht zu Seitenansichten, erfordern aber anwendbare authentifizierte Benutzerkapazitätslizenzen. Weitere Informationen finden Sie in Power Pages häufig gestellten Fragen zur Lizenzierung.
  • Das Aufrufen von Aktionen und Funktionen mithilfe der Portalweb-API wird nicht unterstützt.

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. Das API-Format ist so ähnlich wie möglich, um die Lernkurve zu reduzieren.

Anmerkung

Bei Web-API-Operationen wird zwischen Groß- und Kleinschreibung unterschieden.

In Power Pages verfügbare Web-API-Vorgänge

Website-Einstellungen für die Web-API

Wichtig

Die Unterstützung für den Wildcardwert (*) in der Webapi/<table-name>/fields Websiteeinstellung ist veraltet.

Ersetzen Sie * sie durch eine durch Trennzeichen getrennte Liste der Spalten, die von Ihrer Website benötigt werden. Power Pages Web-API-Anforderungen für Tabellen, die konfiguriert sind, * schlagen fehl, bis Sie explizite Spaltennamen konfigurieren.

Um die Portalweb-API für Ihr Portal zu aktivieren, aktivieren Sie die Websiteeinstellung. Sie können auch die Web-API auf Feldebene konfigurieren, die die Tabellenfelder bestimmt, die Benutzer mithilfe der Portalweb-API ändern können oder nicht ändern können.

Anmerkung

Verwenden Sie den logischen Tabellennamen für diese Einstellungen (z. B. Konto).

Website-Einstellungsname Beschreibung
Webapi/<Tabellenname>/aktiviert Aktiviert oder deaktiviert die Web-API für <Tabellenname>.
Standard:False
Gültige Werte:True, False
Webapi/<Tabellenname>/fields Definiert die durch Trennzeichen getrennte Liste der Attribute, die Benutzer mithilfe der Web-API ändern können.
Mögliche Werte:
- Spezifische Attribute:attr1,attr2,attr3
Wichtig: Bei dieser Einstellung handelt es sich um 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

Wenn Sie beispielsweise die Web-API für die Tabelle "Fall" verfügbar machen möchten, in der authentifizierte Benutzer Datensätze für diese Entität erstellen, aktualisieren und löschen können, verwenden Sie die in der folgenden Tabelle gezeigten Websiteeinstellungen.

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 angeben, da die Anwendungssitzung die Authentifizierung und Autorisierung verwaltet. Alle Web-API-Aufrufe müssen ein CSRF-Token (websiteübergreifende Anforderungsfälschung) enthalten.

Verwenden von EntitySetName

Wenn Sie auf Dataverse-Tabellen verweisen, indem Sie die Portalweb-API in Ihrem Code verwenden, verwenden Sie "EntitySetName". Um auf die Kontotabelle zuzugreifen, z. B. verwendet die Codesyntax den EntitySetName von Konten; /_api/accounts().

Anmerkung

Verwenden Sie den logischen Namen der Tabelle für Websiteeinstellungen (zum Beispiel account).

Führen Sie die folgenden Schritte aus, um den EntitySetName von bestimmten Tabellen zu ermitteln:

  1. Zu https://make.powerapps.com wechseln

  2. Wählen Sie im Seitenbereich die Registerkarte Dataverse und dann die Tabelle aus.

  3. Wählen Sie die Option ... (Befehlsoption) und dann "Erweitert", " Extras" und " Satzname kopieren " aus, um den EntitySetName der Tabelle in die Zwischenablage zu kopieren.

    So finden Sie den EntitySetName einer Dataverse-Tabelle.

Datenschutzgesetze und -vorschriften

Alle Anforderungsheader verwenden eine Kontakt-ID für Überwachungszwecke. Für einen anonymen Benutzer lautet nullder Wert .

Wenn die Überwachungsprotokollierung aktiviert ist, kann ein Benutzer alle Überwachungsereignisse im Office 365-Überwachungsprotokoll anzeigen.

Screenshot des Office 365-Überwachungsprotokolls.

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

Benutzer erhalten einen CDS-Fehler, wenn sie eine GET-Web-API-Anforderung für Tabellen aufrufen, die über mehrere Ebenen von 1:n- oder n:n-Tabellenberechtigungen verfügen, wenn die Bereiche Übergeordnet**, Kontakt oder Konto der Abfrage weitere Bedingungen hinzufügen.

Verwenden Sie FetchXML in der OData-Abfrage, um dieses Problem zu beheben.

Nächster Schritt

Daten über die Portale-Web-API abfragen

  • Last updated on