Portaalien verkko-ohjelmointirajapinnan yleiskuvaus

Huomautus

Power Apps -portaaleja kutsutaan 12. lokakuuta 2022 alkaen nimellä Power Pages. Lisätietoja: Microsoft Power Pages on nyt yleisesti saatavilla (blogi)
Siirrämme ja yhdistämme Power Apps -portaalien dokumentaation pian Power Pagesin dokumentaatioon.

Portaalien verkko-ohjelmointirajapinta mahdollistaa monipuolisemman kokemuksen Power Apps -portaalien sivuilla. Web API:n avulla voit suorittaa luonti-, luku-, päivitys- ja poistotoimintoja kaikissa Microsoft Dataverse -taulukoissa portaalisivuiltasi. Esimerkiksi uuden tilin luominen, yhteyshenkilön päivittäminen tai tuotteen taulukko-oikeuksien muuttaminen voidaan tehdä portaalien verkko-ohjelmointirajapinnan avulla eikä portaalin hallintasovelluksessa.

Huomautus

Voit käyttää myös portaalien verkko-ohjelmointirajapintaa Power Pagesissa. Lisätietoja: Mikä on Power Pages

Tärkeä

• Portaalin version on oltava 9.3.3.x tai uudempi, jotta tämä toiminto toimii oikein.
• Portaalien verkko-ohjelmointirajapinta on suunniteltu luomaan monipuolinen käyttökokemus portaalin sivuille. Sitä ei ole optimoitu kolmannen osapuolen palvelujen tai sovellusten integrointiin. Portaalien verkko-ohjelmointirajapinnan käyttö muihin Power Apps -portaalisivustoihin integrointiin ei myöskään tueta.
• Portaalien verkko-ohjelmointirajapinnan toiminnot tietoihin liittyviin taulukoihin, kuten tileihin, yhteyshenkilöihin tai mukautettuihin taulukoihin. Taulukon metatietojen tai portaalin määritystaulukon tietojen määrittämistä, kuten portaalin adx_contentsnippet-, adx_entityform- tai adx_entitylist-taulukoiden määrittämistä, ei tueta portaalien verkko-ohjelmointirajapinnassa. Täydellinen luettelo on jäljempänä tämän aiheen kohdassa Määritystaulukot, joita ei tueta.
• Portaalien Web API hyötyy palvelinpuolen välimuistista, joten web-ohjelmointirajapinnan myöhemmät kutsut ovat nopeampia kuin alkuperäiset kutsut. Huomaa, että portaalin palvelin puolen välimuistin tyhjennys heikentää suorituskykyä tilapäisesti.
• Portaalien Web API -toiminnot edellyttävät Power Apps -portaalien käyttöoikeutta. Esimerkiksi anonyymien käyttäjien tekemät verkko-ohjelmointirajapintakutsut lasketaan mukaan sivunäkymäkapasiteettiin. Todennettujen (sisäisten tai ulkoisten) käyttäjien tekemät verkko-ohjelmointirajapintakutsuja ei lasketa mukaan sivunäkymiin mutta niitä varten tarvitaan soveltuvat käyttöoikeudet. Lisätietoja: Power Apps -portaalien käyttöoikeuksien usein kysytyt kysymykset

Verkko-ohjelmointirajapinnan toiminnot

Portaalien verkko-ohjelmointirajapintaa sisältää Dataverse -toimintojen ominaisuuksien alijoukon, joita voidaan tehdä Dataverse -ohjelmointirajapinnalla. Ohjelmointirajapinnan muoto on pidetty mahdollisimman samanlaisena, jotta uutta opeteltavaa ei olisi paljon.

Huomautus

Verkko-ohjelmointirajapinnan toiminnot ovat merkkikokoriippuvaisia.

Portaaleissa käytettävissä olevat verkko-ohjelmointirajapinnan toiminnot

• Tietueiden lukeminen taulukosta
• Tietueen luominen taulukkoon
• Taulukon tietueiden päivittäminen ja poistaminen
• Taulukoiden yhdistäminen ja erottaminen

Huomautus

Toimintojen ja funktioiden kutsumista portaalien verkko-ohjelmointirajapintojen avulla ei tueta.

Verkko-ohjelmointirajan sivuston asetukset

Portaalin verkko-ohjelmointirajapinnan käyttöönotto edellyttää, että sivuston asetus on otettu käyttöön. Voit myös määrittää kenttätason Web API:n, joka määrittää taulukkokentät, joita voidaan tai joita ei voi muokata portaalien Web API:lla.

Huomautus

Käytä taulukon loogista nimeä näille asetuksille (esimerkiksi tili).

Sivuston asetuksen nimi	Description
Webapi/<table name>/enabled	Ottaa entiteetin <table name> verkko-ohjelmointirajapinnan käyttöön tai poistaa sen käytöstä. Oletus: False Kelvolliset arvot: True, False
Webapi/<table name>/fields	Määrittää pilkuin erotellun luettelon määritteistä, joita voidaan muokata verkko-ohjelmointirajapinnan avulla. Mahdolliset arvot: - Kaikki määritteet: * - Tietyt määritteet: attr1,attr2,attr3 Huomautus: arvon on oltava joko tähti (*) tai pilkuin eroteltu kenttänimiluettelo. Tärkeää: Tämä on pakollinen sivuston asetus. Jos tämä asetus puuttuu, näkyviin tulee virhe Entiteetille ei ole määritetty yhtään kenttää.
Webapi/virhe/innererror	InnerError otetaan käyttöön tai poistetaan käytöstä. Oletus: False Kelvolliset arvot: True, False
Webapi/<table name>/disableodatafilter	Ottaa OData-suodattimen käyttöön tai poistaa sen käytöstä. Oletus: False Kelvolliset arvot: True, False Lisätietoja on tunnettuja ongelmia käsittelevässä kohdassa. Sivustoasetus on käytettävissä portaalin versiosta 9.4.10.74 alkaen.

Huomautus

Sivuston asetuksissa on valittava Aktiivinen, jotta muutokset otetaan käyttöön.

Seuraavassa taulukossa ovat sivustoasetukset, jolla voidaan tuoda näkyviin palvelupyyntötaulukon verkko-ohjelmointirajapinta, jolla todennetut käyttäjät voivat suorittaa kyseisessä entiteetissä luonti-, päivitys- ja poistotoimintoja.

Sivuston asetuksen nimi	Sivuston asetuksen arvo
Webapi/incident/enabled	true
Webapi/incident/fields	attr1, attr2, attr3

Suojaus portaalien verkko-ohjelmointirajapinnan avulla

Tietuepohjainen suojaus voidaan määrittää portaalin yksittäisiin tietueisiin käyttämällä taulukko-oikeuksia. Portaalien verkko-ohjelmointirajapinta käyttää taulukon (entiteettien) tietueita ja noudattaa taulukkoon liittyviä käyttöoikeuksia, jotka on annettu käyttäjille liittyvän verkkoroolin kautta.

Voit määrittää sarakeoikeudet määrittämään lisäoikeuksia yksittäisiin taulukon sarakkeisiin portaalien verkko-ohjelmointirajapinnan avulla.

Portaalien verkko-ohjelmointirajapinnan pyyntöjen todentaminen

Todennuskoodia ei tarvitse lisätä, koska sovellusistunto hallitsee todennusta ja valtuutusta. Kaikissa verkko-ohjelmointirajapintakutsuissa on oltava CSRF (jaetun julkaisuoikeuspyynnön väärentäminen) -tunnus.

EntitySetName-nimen käyttö

Kun viittaat Dataverse-taulukoihin koodissa portaalien verkkorajapinnan avulla, sinun täytyy käyttää esimerkiksi EntitySetName-nimeä tili-taulukon käyttämiseen. Koodisyntaksi käyttää tilien EntitySetName-nimeä; /_api/accounts().

Huomautus

Käytä sivustoasetusten loogista nimeä näille asetuksille (esimerkiksi tili).

Voit määrittää tiettyjen taulukoiden EntitySetName-nimen seuraavasti:

1. Siirry osoitteeseen https://make.powerapps.com

2. Valitse Dataverse-välilehti sivupaneelista ja valitse taulukko.

3. Valitse ... (Komennot-vaihtoehto) ja kopioi taulukon EntitySetName-nimi leikepöydälle valitsemalla Lisäasetukset, Työkalut ja Kopioi joukon nimi.

   

Yleinen tietosuoja-asetus

Kaikille pyynnön otsikoille välitetään yhteyshenkilön tunnus valvontaa varten. Anonyymin käyttäjän osalta lähetetään null.

Jos valvontalokiin kirjaus on otettu käyttöön, käyttäjä näkee kaikki valvontatapahtumat Office 365:n valvontalokissa.

Lisätietoja:
Toimien lokiin kirjaamisen ottaminen käyttöön ja sen käyttäminen
Valvontalokin tietueiden vieminen, määrittäminen ja näyttäminen

Määritystaulukot, joita ei tueta

Portaalien verkko-ohjelmointirajapintaa ei voi käyttää seuraavissa määritystaulukoissa:

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

Tunnetut ongelmat

Käyttäjät saavat CDS-virheen, jos he käynnistävät sellaisten taulukoiden GET-verkko-ohjelmointirajapinnan pyynnön, joissa on useita 1 moneen- tai monta moneen -taulukko-oikeuksia ja joissa on määritetty ylätason laajuus.

Tämä ongelma kannattaa ratkaista käyttämällä FetchXML-kieltä OData-kyselyssä.

Vaihtoehtoisesti sivuston asetuksen Webapi/<table name>/disableodatafilter arvoksi voidaan määrittää True.

Tärkeä

Jos sivuston asetuksen Webapi/<table name>/disableodatafilter arvoksi muutetaan True, verkko-ohjelmointirajapinnan GET-kutsut voivat hidastua.

Sivustoasetus on käytettävissä portaalin versiosta 9.4.10.74 alkaen.

Seuraava vaihe

Tietojen kysely portaalien Web API:n avulla

Katso myös

HTTP-pyyntöjen laatiminen ja virheiden käsitteleminen
Portaalien Web API -kirjoitus-, päivitys- ja poistotoimintojen käyttäminen
Opasohjelma: portaalin verkko-ohjelmointirajapinnan käyttäminen

Huomautus

Voitko kertoa meille dokumentaatiota koskevan kielimäärityksesi? Vastaa lyhyeen kyselyyn. (Huomaa, että tämä kysely on englanninkielinen.)

Kyselyyn vastaaminen kestää noin seitsemän minuuttia. Henkilökohtaisia tietoja ei kerätä (tietosuojatiedot).