Prezentare generală a API-ului web pentru portaluri
API-ul web pentru portaluri permite o experiență mai bogată a utilizatorului în site-urile Power Pages. Puteți utiliza API-ul web pentru a efectua operațiuni de creare, citire, actualizare și ștergere în toate tabelele Microsoft Dataverse din paginile web. De exemplu, puteți crea un cont nou, puteți actualiza o persoană de contact, fără a utiliza un formular sau formular cu mai mulți pași folosind API-ul web pentru portaluri.
Important
- Versiunea site-ului dvs. Power Pages 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. De asemenea, nu este acceptată utilizarea API-ului web pentru portaluri pentru a integrarea cu alte site-uri Power Pages.
- Operațiunile API pentru portaluri web sunt limitate la tabele legate de date, de exemplu, conturi, persoane de contact 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ță Power Pages. De exemplu, apelurile API web efectuate de utilizatori anonimi sunt luate în considerare pentru capacitatea de utilizatori anonimi. 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 pentru capacitatea de utilizatori autentificați. Mai multe informații: Întrebări frecvente de licențiere Power Pages
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 Power Pages
- 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 tabelelor
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/<nume tabel>/enabled | Activează sau dezactivează API-ul Web pentru <numele de tabel>. Implicit: False Valori valide:: True, False |
| Webapi/<nume tabel>/fields | 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/error/innererror | Activează sau dezactivează InnerError. Implicit: False Valori valide:: True, False |
| Webapi/<nume tabel >/disableodatafilter | Activează sau dezactivează filtrul OData API. Implicit: False Valori valide: True, False Consultați probleme cunoscute pentru mai multe informații. 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/enabled | true |
| Webapi/incident/fields | 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:
Treceți la https://make.powerapps.com
Selectați fila Dataverse din panoul lateral și selectați tabelul.
Selecteați ... (Opțiune comenzi) și apoi alegeți Avansat, Instrumente și Copiați numele setului pentru a copia EntitySetName a tabelului în clipboard.
Legile și reglementările privind confidențialitatea
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 GET solicitare API Web pentru tabele care au mai multe niveluri de la 1 la mai multe sau multe până la multepermisiuni de masă când Parental, Contact sau Domeniile contului adaugă condiții suplimentare la interogare.
Pentru a rezolva această problemă, soluția recomandată este utilizarea FetchXML în interogarea OData.
Ca alternativă, setați setarea site-ului Webapi/<nume tabel>/disableodatafilter la True.
Important
Modificarea setării site-ului Webapi/<numele tabelului>/disableodatafilter la True ar putea duce la o încetinire a performanței 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