Overzicht van Web-API voor portals
De web-API voor portals zorgt voor een rijkere gebruikerservaring binnen Power Pages-sites. U kunt de web-API gebruiken om voor alle Microsoft Dataverse-tabellen van uw webpagina's bewerkingen voor maken, lezen, bijwerken en verwijderen uit te voeren. U kunt bijvoorbeeld een nieuw account aanmaken of een contactpersoon bijwerken zonder een formulier of formulier voor meerdere stappen te gebruiken door de web-API voor portals te gebruiken.
Belangrijk
- De versie van uw Power Pages-site moet 9.3.3.x of hoger zijn om deze functie te laten werken.
- De web-API voor portals is gebouwd om een rijkere gebruikerservaring binnen portalpagina's te maken. Het is niet geoptimaliseerd voor services van derden of integratie van toepassingen. Het gebruik van de Web-API van de portal om te integreren met andere Power Pages-sites wordt ook niet ondersteund.
- Bewerkingen van de web-API voor portals zijn beperkt tot tabellen die zijn gerelateerd aan gegevens, bijvoorbeeld accounts, contactpersonen of uw aangepaste tabellen. Configuratie van tabelmetagegevens of portalconfiguratietabelgegevens (bijvoorbeeld het configureren van portaltabellen zoals adx_contentsnippet, adx_entityform of adx_entitylist) wordt niet ondersteund met de web-API voor portals. Ga voor een volledige lijst naar niet-ondersteunde configuratietabellen verderop in dit onderwerp.
- De web API voor portals profiteert van het opslaan in cache op de server, dus volgende aanroepen naar de web API zijn sneller dan de eerste aanroepen. Houd er rekening mee dat het wissen van de servercache van de portal tijdelijke prestatieverlies veroorzaakt.
- Voor bewerkingen met de web-API voor portals is een Power Pages-licentie vereist. Web-API-aanroepen van anonieme gebruikers worden bijvoorbeeld meegeteld voor de capaciteit van anonieme gebruikers. Web-API-aanroepen door geverifieerde gebruikers (intern of extern) worden niet meegeteld voor paginaweergaven, maar vereisen toepasselijke licenties voor capaciteit van geverifieerde gebruikers. Meer informatie: Veelgestelde vragen over Power Pages-licenties
Web-API-bewerkingen
De web-API voor portals biedt een subset van mogelijkheden voor Dataverse-bewerkingen die u kunt uitvoeren met de Dataverse-API. We hebben de API-indeling zo veel mogelijk gelijk gehouden om de leercurve te verminderen.
Notitie
Web-API-bewerkingen zijn hoofdlettergevoelig.
Web-API-bewerkingen beschikbaar in Power Pages
- Records van een tabel lezen
- Een record in een tabel maken
- Records in een tabel bijwerken en verwijderen
- Tabellen koppelen en loskoppelen
Site-instellingen voor de web-API
U moet de site-instelling inschakelen om de web-API voor portals voor uw portal in te schakelen. U kunt de web-API op veldniveau configureren die bepaalt welke tabelvelden wel of niet kunnen worden gewijzigd met de web-API voor portals.
Notitie
Gebruik de tabel logische naam voor deze instellingen (bijvoorbeeld account).
| Naam van site-instelling | Omschrijving |
|---|---|
| Webapi/<tabelnaam>/enabled | Schakelt de web-API in of uit voor <tabelnaam>. Standaard: False Geldige waarden: True, False |
| Webapi/<tabelnaam>/fields | Definieert de door komma's gescheiden lijst met kenmerken die kunnen worden gewijzigd met de web-API. Mogelijke waarden: - Alle kenmerken: * - Specifieke kenmerken: attr1,attr2,attr3 Opmerking: de waarde moet een asterisk (*) of een door komma's gescheiden lijst met veldnamen zijn. Belangrijk: dit is een verplichte site-instelling. Als deze instelling ontbreekt, ziet u de fout 'Geen velden gedefinieerd voor deze entiteit'. |
| Webapi/error/innererror | Hiermee wordt InnerError in- of uitgeschakeld. Standaard: False Geldige waarden: True, False |
| Webapi/<tabelnaam>/disableodatafilter | Hiermee wordt het OData-filter in- of uitgeschakeld. Standaard: False Geldige waarden: True, False Zie Bekende problemen voor meer informatie. De site-instelling is beschikbaar in de portalversie 9.4.10.74 of later. |
Notitie
Wijzigingen worden alleen van kracht als Site-instellingen is ingesteld op Actief.
Als u bijvoorbeeld de web-API voor de tabel Aanvraag wilt weergeven, waar geverifieerde gebruikers maak-, bijwerk- en verwijderbewerkingen op deze entiteit mogen uitvoeren, worden de site-instellingen weergegeven in de volgende tabel.
| Naam van site-instelling | Waarde Site-instelling |
|---|---|
| Webapi/incident/enabled | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
Beveiliging met de web-API voor portals
U kunt op records gebaseerde beveiliging configureren voor individuele records in portals met tabelmachtigingen. De web-API voor portals heeft toegang tot tabelrecords en volgt de tabelmachtigingen die aan gebruikers zijn gegeven via de toegewezen webrol.
U kunt kolommachtigingen configureren om bevoegdheden voor afzonderlijke kolommen binnen een tabel verder te definiëren tijdens het gebruik van de web-API voor portals.
Aanvragen voor web-API voor portals verifiëren
U hoeft geen verificatiecode op te nemen, omdat de verificatie en autorisatie worden beheerd door de toepassingssessie. Alle web-API-aanroepen moeten een CSRF-token (Cross-Site Request Forgery) bevatten.
EntitySetName gebruiken
Bij verwijzing naar Dataverse-tabellen met behulp van de Web-API van de portal in uw code, moet u de EntitySetName gebruiken. Om toegang te krijgen tot de account-tabel, gebruikt de codesyntaxis bijvoorbeeld de EntitySetName accounts ; /_api/accounts().
Notitie
Gebruik de tabel logische naam voor site-instellingen (bijvoorbeeld account).
U kunt de EntitySetName van specifieke tabellen bepalen door deze stappen te volgen:
Ga naar https://make.powerapps.com
Selecteer het tabblad Dataverse in het zijpaneel en selecteer de tabel.
Selecteer ... (optie Meer opdrachten) en kies vervolgens Geavanceerd, Hulpmiddelen en Setnaam kopiëren om de EntitySetName te kopiëren van de tabel naar uw klembord.
Privacywet- en regelgeving
Alle aanvraagheaders hebben een contact-id die is doorgegeven voor controledoeleinden. Voor een anonieme gebruiker wordt dit doorgegeven als null.
Als auditregistratie is ingeschakeld, kan een gebruiker alle auditgebeurtenissen zien in het Office 365-auditlogboek.
Meer informatie:
Logboekregistratie van activiteiten inschakelen en gebruiken
Auditlogboekrecords exporteren, configureren en weergeven
Niet-ondersteunde configuratietabellen
De web-API kan niet worden gebruikt voor de volgende configuratietabellen:
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
Bekende problemen
Gebruikers krijgen een CDS-fout als ze een GET Web-API-aanvraag indienen voor tabellen met meerdere niveaus van 1 tot veel of veel tot veeltabelrechten wanneer de bereiken Bovenliggend, Contact of Account aanvullende voorwaarden toevoegen aan de query.
Om dit probleem op te lossen, is de aanbevolen oplossing FetchXML in de OData-query.
U kunt ook de site-instelling Webapi/<tabelnaam>/disableodatafilter instellen op True.
Belangrijk
Als u de site-instelling Webapi/<tabelnaam>/disableodatafilter wijzigt in True, kan dit leiden tot tragere prestaties voor de GET-aanroepen van de web-API.
De site-instelling is beschikbaar in de portalversie 9.4.10.74 of later.
Volgende stap
Query voor gegevens uitvoeren met de web-API voor portals