Oversigt over Web-API til portaler

Web-API-portaler gør det muligt at få en mere omfattende brugeroplevelse på Power Pages-steder. Du kan bruge web-API-portaler til at oprette, læse, opdatere og slette handlinger på tværs af alle Microsoft Dataverse-tabeller fra dine websider. Du kan f.eks. oprette et nyt firma, opdatere en kontakt uden at bruge formular eller formular med flere trin ved hjælp af Web-API-portaler.

Vigtigt

  • Dit Power Pages-webstedsversion skal være 9.3.3.x eller nyere, for at denne funktion kan fungere.
  • Web-API'en til portaler er bygget for at skabe en bedre brugeroplevelse på portalsider. Den er ikke optimeret til tredjepartstjenester eller programintegration. Brug af portalweb-API'en til at integrere med andre Power Pages-websteder understøttes heller ikke.
  • Web-API-handlinger på portaler er begrænset til tabeller, der er relateret til data – for eksempel konti, kontakter eller dine brugerdefinerede tabeller. Konfiguration af tabelmetadata eller data om portalkonfigurationstabeller – for eksempel konfiguration af portaltabeller som adx_contentsnippet, adx_entityform eller adx_entitylist – understøttes ikke med web-API'en til portaler. Hvis du vil have en komplet liste, skal du gå til ikke-understøttede konfigurationstabeller senere i dette emne.
  • Portalerne web-API har fordel af cachelagring på serversiden, så efterfølgende kald til web-API'en er hurtigere end de første opkald. Bemærk, at rydning af portalserverens cache medfører midlertidig forringelse af ydeevnen.
  • Web-API-portalhandlinger kræver en Power Pages-licens. Web-API-kald, der er foretaget af anonyme brugere, tælles f.eks. med i den anonyme brugers kapacitet. Web-API-kald, der er foretaget af godkendte brugere (interne eller eksterne), tælles ikke med i sidevisninger, men kræver relevante godkendte brugerkapacitetslicenser. Flere oplysninger: Ofte stillede spørgsmål om Power Pages-licenser

Web-API-handlinger

Web-API'en til portaler tilbyder et undersæt af funktioner til Dataverse-handlinger, som du kan udføre ved hjælp af Dataverse-API'en. Vi har gjort API-formatet så ens som muligt for at reducere indlæringskurven.

Bemærk

Der er forskel på store og små bogstaver i Web-API-handlinger.

Web-API-handlinger, der er tilgængelige i Power Pages

Bemærk

Kalder handlinger og funktioner ved hjælp af portalweb-API'en understøttes ikke.

Indstillinger for websted for web-API

Du skal aktivere webstedsindstillingen for at aktivere web-API'en til din portal. Du kan også konfigurere den web-API på feltniveau, der bestemmer de tabelfelter, der kan eller ikke kan ændres med portalweb-API'en.

Bemærk

Brug tabellens logiske navn til disse indstillinger (f.eks. firma).

Navn på indstilling for websted Description
Webapi/<tabelnavn>/aktiveret Aktiverer eller deaktiverer web-API til <tabelnavn>.
Standard:False
Gyldige værdier:True, False
Webapi/<tabelnavn>/felter Definerer den kommaseparerede liste over attributter, der kan redigeres med web-API'en.
Mulige værdier:
- Alle attributter:*
- Specifikke attributter:attr1,attr2,attr3
Bemærk: Værdien skal enten være en stjerne (*) eller en kommasepareret liste over feltnavne.
Vigtigt! Dette er en obligatorisk indstilling for webstedet. Når denne indstilling mangler, vises fejlmeddelelsen "Der er ikke defineret felter for dette objekt".
Webapi/error/innererror Aktiverer eller deaktiverer InnerError.
Standard:False
Gyldige værdier:True, False
Webapi/<tabelnavn>/disableodatafilter Aktiverer eller deaktiverer OData-filter.
Standard:False
Gyldige værdier:True, False Se kendte problemer for at finde flere oplysninger. Indstillingen for websted er tilgængelig i portalversion 9.4.10.74 eller nyere.

Bemærk

Indstillinger for websted skal angives til Aktiv, for at ændringerne kan træde i kraft.

Hvis du for eksempel vil have vist web-API'en for sagstabellen, hvor godkendte brugere har tilladelse til at udføre oprettelses-, opdaterings- og slettehandlinger for dette objekt, vises indstillingerne for webstedet i følgende tabel.

Navn på indstilling for websted Værdi af indstilling for websted
Webapi/incident/enabled sand
Webapi/incident/fields attr1, attr2, attr3

Sikkerhed med web-API'en til portaler

Du kan konfigurere postbaseret sikkerhed for individuelle poster på portaler ved hjælp af tabeltilladelser. Portalerne Web API giver adgang til tabelposter (objekt) og følger de tabeltilladelser, der gives til brugere via de tilknyttede webroller.

Du kan konfigurere kolonnetilladelser for yderligere at definere rettigheder til individuelle kolonner i en tabel, mens du bruger portalweb-API'en.

Godkendelse af portalers Web-API-forespørgsler

Du behøver ikke at inkludere en godkendelseskode, da godkendelse og godkendelse administreres af programsessionen. Alle Web-API-kald skal inkludere et CSRF-token (forfalskning af anmodning på tværs af websteder).

Brug af EntitySetName

Når du henviser til Dataverse-tabeller ved hjælp af portalweb-API'en i din kode, skal du f.eks. bruge EntitySetName til at få adgang til kontotabellen. Kodesyntaksen bruger EntitySetName for firmaer/_api/accounts().

Bemærk

Brug tabellens logiske navn for websteds-indstillinger (f.eks. firma).

Du kan bestemme EntitySetName for bestemte tabeller ved at følge disse trin:

  1. Gå til https://make.powerapps.com

  2. Vælg fanen Dataverse i sidepanelet, og vælg tabellen.

  3. Vælg indstillingen ... (Kommandoer), og vælg derefter Avanceret, Funktioner og Kopiér sætnavn for at kopiere tabellens EntitySetName til Udklipsholder.

    Sådan finder du EntitySetName for en Dataverse-tabel.

Lovgivning og regler om beskyttelse af personlige oplysninger

Alle anmodnings-overskrifter har kontakt-id, der er overført til overvågningsformål. Hvis det gælder for en anonym bruger, overføres dette som null.

Hvis overvågningsloggen er aktiveret, kan en bruger se alle overvågningshændelserne i Office 365-overvågningsloggen.

Office 365-overvågningslog..

Flere oplysninger:
Aktivere og bruge logføring af aktiviteter
Eksportere, konfigurere og vise poster i overvågningsloggen

Ikke-understøttede konfigurationstabeller

Web-API'en til portaler kan ikke bruges til følgende konfigurationstabeller:

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

Kendte problemer

Brugere får en CDS-fejl, hvis de aktiverer en GET Web-API-anmodning om tabeller, der har flere niveauer på 1 til mange eller mange til mangetabeltilladelser, når Overordnet, Kontakt eller Konto føjer yderligere betingelser til forespørgslen.

Den anbefalede løsning for at løse dette problem er at bruge FetchXML i OData-forespørgslen.

Du kan også angive webstedsindstillingen Webapi/<tabelnavn>/disableodatafilter til True.

Vigtigt

Hvis du ændrer webstedsindstillingen Webapi/<tabelnavn>/disableodatafilter til True, kan det resultere i langsommere ydeevne for web API GET-kald.

Indstillingen for websted er tilgængelig i portalversion 9.4.10.74 eller nyere.

Næste trin

Forespørgsel efter data ved hjælp af portaler Web API

Se også