Prezentare generală a API-ului web pentru portaluri

Notă

Începând cu 12 octombrie 2022, portalurile Power Apps sunt Power Pages. Mai multe informații: Microsoft Power Pages este acum disponibil în general (blog)
În curând vom migra și vom îmbina documentația portalurilor Power Apps cu documentația Power Pages.

Portalul Web API permite o experiență mai bogată a utilizatorului în interiorul paginilor de portaluri Power Apps. Puteți utiliza API-ul web pentru a efectua operațiuni de creare, citire, actualizare și ștergere în toate tabelele Microsoft Dataverse din paginile portalurilor. De exemplu, puteți crea un cont nou, puteți actualiza o persoană de contact sau puteți schimba permisiunile de tabel pentru un produs utilizând portalurile web API în loc de aplicația Gestionarea portalului.

Notă

De asemenea, puteți utiliza portalurile Web API în Power Pages. Mai multe informații: Ce este Power Pages

Important

• Versiunea portalului dvs. trebuie să fie 9.3.3.x sau mai recentă pentru ca această caracteristică să funcționeze.
• Portalul Web API este construit pentru crearea unei experiențe bogate a utilizatorului în interiorul paginilor de portaluri. Nu este optimizat pentru servicii terțe sau integrarea aplicațiilor. Utilizarea portalurilor Web API pentru a se integra cu alte site-urile portalurilor Power Apps nu este acceptată.
• Operațiunile API pentru portaluri web sunt limitate la tabele legate de date—de exemplu, conturi, contacte sau tabelele dvs. particularizate. Configurarea metadatelor tabelului sau a datelor tabelului de configurare a portalului—de exemplu, configurarea tabelelor de portaluri precum adx_contentsnippet, adx_entityform sau adx_entitylist—nu este acceptată cu portalurile web API. Pentru o listă completă, accesați tabele de configurare neacceptate ulterior în acest subiect.
• Portalurile Web API beneficiază de stocarea în cache a serverului deci apelurile ulterioare către API-ul Web sunt mai rapide decât apelurile inițiale. Rețineți că ștergerea memoria cache la nivelul serverului pentru un portal determină degradarea temporară a performanței.
• Operațiile de portaluri web API necesită o licență portaluri Power Apps. De exemplu, apelurile API web efectuate de utilizatori anonimi sunt luate în considerare pentru capacitatea de vizualizare a paginii. Apelurile web API efectuate de utilizatori autentificați (interni sau externi) nu sunt luate în considerare pentru vizualizările de pagină, dar necesită licențe aplicabile. Mai multe informații: Întrebări frecvente despre licențierea portalurilor Power Apps

Operațiuni API web

Portalul Web API oferă un subset de capabilități pentru operațiuni Dataverse pe care le puteți face utilizând API Dataverse. Am păstrat formatul API cât mai similar posibil pentru a reduce curba de învățare.

Notă

Operațiunile Web API țin cont de majuscule și minuscule.

Operațiuni API web disponibile în portaluri

• Citiți înregistrările dintr-un tabel
• Creați o înregistrare într-un tabel
• Actualizați și ștergeți înregistrările dintr-un tabel
• Asociați și anulați asocierea tabele

Notă

Apelarea actiuni și funcții utilizând portalurile Web API nu este acceptată.

Setările site-ului pentru API-ul Web

Trebuie să activați setarea site-ului pentru a activa portalurile web API pentru portalul dvs. De asemenea, puteți configura API-ul web la nivel de câmp care determină câmpurile de tabel care pot sau nu pot fi modificate cu portalurile web API.

Notă

Folosiți tabelul nume logic pentru aceste setări (de exemplu cont).

Nume setare de site	Descriere
Webapi/<table name>/activat	Activează sau dezactivează API-ul Web pentru <table name>. Implicit: False Valori valide: True, False
Webapi/<table name>/câmpuri	Definește lista de atribute separate prin virgulă care pot fi modificate cu API-ul Web. Valorile posibile: - Toate atributele: * - Atribute specifice: attr1,attr2,attr3 Notă: Valoarea trebuie să fie fie un asterisc (*) sau o listă de nume de câmpuri separate prin virgulă. Important: Aceasta este o setare obligatorie a site-ului. Când această setare lipsește, veți vedea eroarea „Nu există câmpuri definite pentru această entitate”.
Webapi/eroare/innererror	Activează sau dezactivează InnerError. Implicit: False Valori valide: True, False
Webapi/<table name>/disableodatafilter	Activează sau dezactivează filtrul OData API. Implicit: False Valori valide: True, False Consultați probleme cunoscute pentru informații suplimentare. Setarea site-ului este disponibilă în versiunea portalului 9.4.10.74 sau ulterioară.

Notă

Setările site-ului trebuie să fie setate pe Activ pentru ca modificările să intre în vigoare.

De exemplu, pentru a expune API-ul web pentru tabelul Caz unde utilizatorii autentificați au permisiunea de a efectua operațiuni de creare, actualizare și ștergere pe această entitate, setările site-ului sunt afișate în tabelul următor.

Nume setare de site	Valoarea setării de site
Webapi/incident/activat	true
Webapi/incidente/câmpuri	attr1, attr2, attr3

Securitate cu portalurile Web API

Puteți configura securitatea bazată pe înregistrări la înregistrările individuale din portaluri utilizând permisiunile de tabel. Portalurile web API accesează înregistrările tabelelor (entitate) și urmează permisiunile de tabel date utilizatorilor prin intermediul rolului web asociat.

Puteți configura permisiunile coloanei pentru a defini în continuare privilegii pentru coloanele individuale dintr-un tabel în timp ce utilizați API-ul web portals.

Autentificarea solicitărilor de API web pentru portaluri

Nu trebuie să includeți un cod de autentificare, deoarece autentificarea și autorizarea sunt gestionate de sesiunea de aplicație. Toate apelurile API Web trebuie să includă un jeton CSRF (Cross-Site Request Forgery).

Folosirea EntitySetName

Când vă referiți la tabelele Dataverse care utilizează portalurile API Web în codul dvs., trebuie să utilizați EntitySetName, de exemplu, pentru a accesa tabelul cont, sintaxa codului va folosi EntitySetName a conturilor /_api/accounts().

Notă

Folosiți tabelul logic pentru setări site (de exemplu, cont).

Puteți determina EntitySetName a unor tabele specifice urmând acești pași:

1. Treceți la https://make.powerapps.com

2. Selectați fila Dataverse din panoul lateral și selectați tabelul.

3. Selecteați ... (Opțiune comenzi) și apoi alegeți Avansat, Instrumente și Copiați numele setului pentru a copia EntitySetName a tabelului în clipboard.

   

Regulamentul general privind protecția datelor (RGPD)

Toate antetele solicitării vor avea un ID de contact transmis în scopuri de audit. Pentru un utilizator anonim, acesta va fi transmis ca null.

Dacă jurnalul de audit este activat, un utilizator poate vedea toate evenimentele de audit din Jurnal de audit Office 365.

Informații suplimentare:
Activați și folosiți înregistrarea activității
Exportați, configurați și vizualizați înregistrările jurnalului de audit

Tabele de configurare neacceptate

Portalurile web API nu pot fi utilizate pentru următoarele tabele de configurare:

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

Probleme cunoscute

Utilizatorii vor primi o eroare CDS dacă invocă o solicitare GET API web pentru tabele care au mai multe niveluri de 1 la mulți sau mulți la mulți permisiuni de tabel cu părinte domeniul de aplicare definit.

Pentru a rezolva această problemă, soluția recomandată este utilizarea FetchXML în interogarea OData.

Alternativ, setați setarea site-ului Webapi/<table name>/disableodatafilter la True.

Important

Modificarea setării site-ului Webapi/<table name>/disableodatafilter la True poate duce la o performanță mai lentă pentru apelurile Web API GET.

Setarea site-ului este disponibilă în versiunea portalului 9.4.10.74 sau ulterioară.

Pasul următor

Interogați datele utilizând portalurile API Web

Consultați și

Compunerea de solicitări HTTP și gestionarea erorilor
Portalurile scrie, actualizează și șterg operații utilizând API-ul web
Tutorial: Utilizarea API-ului web pentru portal

Notă

Ne puteți spune care preferințele dvs. lingvistice pentru documentație? Răspundeți la un chestionar scurt. (rețineți că acest chestionar este în limba engleză)

Chestionarul va dura aproximativ șapte minute. Nu sunt colectate date personale (angajament de respectare a confidențialității).