Oversikt over nett-API for portaler
Nett-API-en for portaler gir en omfattende brukeropplevelse på Power Pages-nettsteder. Du kan bruke nett-API-en til å utføre operasjoner for å opprette, lese, oppdatere og slette operasjoner på tvers av Microsoft Dataverse-tabeller fra nettstedssidene. Du kan for eksempel opprette en ny forretningsforbindelse, oppdatere en kontakt, uten å bruke et skjema eller flertrinnsskjema ved hjelp av portalenes web-API.
Viktig
- Power Pages-nettstedsversjonen må være 9.3.3.x eller senere for at denne funksjonen skal fungere.
- Portal-Web-API-en er bygd for å opprette en rikere brukeropplevelse på portalsider. Den er ikke optimalisert for tredjepartstjenester eller programintegrering. Det er heller ikke støtte for å bruke nett-API-en for portaler til integrering med andre Power Pages-nettsteder.
- Operasjoner for web-API for portaler er begrenset til tabeller som er relatert til data, for eksempel forretningsforbindelser, kontakter eller egendefinerte tabeller. Konfigurasjon av tabellmetadata eller portalkonfigurasjonstabelldata, for eksempel konfigurasjon av portaltabeller, for eksempel adx_contentsnippet, adx_entityform eller adx_entitylist, støttes ikke med web-API-en for portalene. Hvis du vil ha en fullstendig liste, kan du gå til konfigurasjonstabeller som ikke støttes senere i dette emnet.
- Web-APIen for portaler drar nytte av hurtigbufring på serversiden, slik at etterfølgende kall til web-APIen går raskere enn de første kallene. Legg merke til at tømming av hurtigbufferen på portalserversiden vil midlertidig forårsake redusert ytelse.
- Web-API-operasjoner for portaler krever en Power Pages-lisens. Web-API-kall som utføres av anonyme brukere, telles for eksempel med i forhold til den anonyme brukerkapasiteten. Web-API-kall som utføres av godkjente brukere (interne eller eksterne), telles ikke med i sidevisninger, men krever gjeldende godkjente brukerkapasitetslinsenser. Mer informasjon: Vanlige spørsmål om lisensiering for Power Pages
Nett-API-operasjoner
Portal-Web-API-en har et delsett av funksjoner for Dataverse-operasjoner som du kan utføre ved hjelp av Dataverse-API-en. Vi har behold API-formatet så likt som mulig, for å redusere læringskurven.
Merk
Det skiller mellom små og store bokstaver i operasjoner for web-API.
Nett-API-operasjoner som er tilgjengelige i Power Pages
- Lese poster fra en tabell
- Opprette en oppføring i en tabell
- Oppdater og slett oppføringer i en tabell
- Tilknytt og fjern tilknytning av tabeller
Merk
Kalle opp handlinger og funksjoner ved hjelp av web-API-en for portaler støttes ikke.
Nettstedsinnstillinger for Web-API-en
Du må aktivere nettstedsinnstillingen for å aktivere portal-Web-API-en. Du kan også konfigurere web-APIen på feltnivå som bestemmer tabellfeltene som kan eller ikke kan endres med web-API-et for portaler.
Merk
Bruk det logiske tabellnavnet for disse innstillingene (for eksempel forretningsforbindelse).
Navn på nettstedinnstilling | Bekrivelse |
---|---|
Webapi/<table name>/enabled | Aktiverer eller deaktiverer Web-API-en for <tabellnavn>. Standard: False Gyldige verdier: True , False |
Webapi/<table name>/fields | Definerer den kommadelte listen over attributter som kan endres med Web-API-en. Mulige verdier: - Alle attributter: * - Spesifikke attributter: attr1,attr2,attr3 Merk: Verdien må enten være en stjerne (*) eller en kommadelt liste over feltnavn. Viktig! Dette er en obligatorisk nettstedsinnstilling. Når denne innstillingen mangler, vises feilmeldingen «Ingen felt er definert for denne enheten». |
Webapi/error/innererror | Aktiverer eller deaktiverer InnerError. Standard: False Gyldige verdier: True , False |
Webapi/<table name>/disableodatafilter | Aktiverer eller deaktiverer OData-filteret. Standard: False Gyldige verdier: True , False Se kjente problemer for mer informasjon. Områdeinnstillingen er tilgjengelig i portalversjonen av 9.4.10.74 eller senere. |
Merk
Områdeinnstillinger må være satt til aktive for at endringer skal tre i kraft.
Hvis du for eksempel vil vise web-API-en for sakstabellen der godkjente brukere har tillatelse til å utføre operasjoner for oppretting, oppdatering og sletting for denne enheten, vises områdeinnstillingene i tabellen nedenfor.
Navn på nettstedsinnstilling | Nettstedinnstilling-verdi |
---|---|
Webapi/incident/enabled | sann |
Webapi/incident/fields | attr1, attr2, attr3 |
Sikkerhet med portal-Web-API-en
Du kan konfigurere oppføringsbasert sikkerhet for enkeltoppføringer i portaler ved å bruke tabelltillatelser. Web-API for portaler får tilgang til tabellposter (enhetsposter) og følger tabelltillatelsene som gis til brukere via den tilknyttede webrollen.
Du kan konfigurere kolonnetillatelser for ytterligere å definere rettigheter for enkeltkolonner i en tabell når du bruker web-API-en for portaler.
Nett-API-forespørsler for godkjenning av portaler
Du trenger ikke å inkludere en godkjenningskode fordi godkjenning og autorisasjon administreres av programøkten. Alle Web-API-kall må inneholde et forfalskning av forespørsler på tvers av nettsteder-token (CSRF).
Bruk av EntitySetName
Når du refererer til Dataverse-tabeller ved hjelp av web-API-en for portalene i koden, må du for eksempel bruke EntitySetName for å få tilgang til tabellen over forretningsforbindelser. Kodesyntaksen bruker EntitySetName for forretningsforbindelser; /_api/accounts()
.
Merk
Bruk det logiske tabellnavnet for disse stedsinnstillingene (for eksempel forretningsforbindelse).
Du kan bestemme EntitySetName for bestemte tabeller ved å følge disse trinnene:
Gå til https://make.powerapps.com
Velg Dataverse-fanen fra sidepanelet, og velg tabellen.
Velg ... (Kommandoer-alternativet), og velg deretter Avansert, Verktøy og Kopier settnavn for å kopiere EntitySetName i tabellen til utklippstavlen.
Personvernlover og -forskrifter
Alle forespørselshoder har en kontakt-ID som sendes for revisjonsformål. For en anonym bruker blir dette sendt som null
.
Hvis sporing av endringer er aktivert, kan en bruker se alle hendelser for sporing av endringer i Office 365-loggen for sporing av endringer.
Mer informasjon:
Aktivere og bruke aktivitetslogging
Eksportere, konfigurere og vise revisjonsloggoppføringer
Konfigurasjonstabeller som ikke støttes
Web-API-en for portaler kan ikke brukes for konfigurasjonstabellene nedenfor:
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
Kjente problemer
Brukere får en CDS-feil hvis de aktiverer nett-API-forespørselen GET
for tabeller som har flere nivåer med 1-til-mange- eller mange-til-mange-relasjoner tiltabelltillatelser når områdene Overordnet, Kontakt eller Forretningsforbindelse legger til flere betingelser i spørringen.
For å løse dette problemet er den anbefalte løsningen å bruke FetchXML i OData-spørringen.
Du kan også angi områdeinnstillingen Webapi/<table name>/disableodatafilter til True
.
Viktig
Endring av områdeinnstillingen Webapi/<table name>/disableodatafilter til True
kan føre til lavere ytelse for web-API GET
-kall.
Områdeinnstillingen er tilgjengelig i portalversjonen av 9.4.10.74 eller senere.
Neste trinn
Spørre etter data ved hjelp av web-API for portaler