Gambaran keseluruhan API Web portal
Portal API Web membolehkan pengalaman pengguna lebih banyak dalam tapak Power Pages. Anda boleh menggunakan API Web untuk melaksanakan mencipta, membaca, mengemas kini dan memadam operasi merentasi semua jadual Microsoft Dataverse dari halaman web anda. Sebagai contoh, anda boleh mencipta akaun baharu, mengemas kini kenalan tanpa menggunakan borang atau Borang berbilang langkah dengan menggunakan API Web Portal.
Penting
- Versi tapak Power Pages anda mestilah 9.3.3.x atau lebih baru untuk ciri ini berfungsi.
- Portal API Web dibina untuk mencipta pengalaman pengguna lebih banyak dalam halaman portal. Ia tidak dioptimumkan untuk perkhidmatan pihak ketiga atau integrasi aplikasi. Menggunakan portal API Web untuk mengintegrasikan dengan tapak web Power Pages lain juga tidak disokong.
- Operasi Portal API Web adalah terhad kepada jadual yang berkaitan dengan data—contohnya, akaun, kenalan atau jadual tersuai anda. Mengkonfigurasi data jadual metadata atau jadual konfigurasi portal—misalnya, mengkonfigurasi jadual portal seperti adx_contentsnippet, adx_entityform, atau adx_entitylist—tidak disokong dengan portal API Web. Untuk senarai lengkap, pergi ke jadual konfigurasi yang tidak disokong kemudian dalam topik ini.
- API Web portal manfaat dari cache bahagian pelayan, jadi panggilan berikutnya kepada API Web lebih cepat daripada panggilan awal. Ambil perhatian bahawa pengosongan cache bahagian pelayan portal menyebabkan penurunan prestasi sementara.
- Operasi API Web portal memerlukan lesen Power Pages. Sebagai contoh, panggilan API Web yang dibuat oleh pengguna tanpa nama dikira dalam kapasiti pengguna tanpa nama. Panggilan API Web yang dibuat oleh pengguna yang disahkan (dalaman atau luaran) tidak dikira dalam paparan halaman, tetapi memerlukan lesen kapasiti pengguna disahkan yang berkenaan. Maklumat lanjut: Soalan Lazim pelesenan Power Pages
Operasi API Web
API Web portal menawarkan subset keupayaan untuk Dataverse operasi yang boleh anda lakukan dengan menggunakan API Dataverse. Kami telah menyimpan format API yang sama yang mungkin untuk mengurangkan lengkung pembelajaran.
Nota
Operasi API web adalah sensitif huruf.
Operasi API Web tersedia di Power Pages
- Baca rekod daripada jadual
- Cipta rekod dalam jadual
- Kemas kini dan padamkan rekod dalam jadual
- Mengaitkan dan menyahkaitkan jadual
Tetapan tapak untuk API Web
Anda mesti mendayakan tetapan tapak untuk mendayakan API Web portal untuk portal anda. Anda juga boleh mengkonfigurasi API Web paras medan yang menentukan medan jadual yang boleh atau tidak boleh diubah suai dengan API Web portal.
Nota
Gunakan nama logik jadual untuk tetapan ini (sebagai contoh akaun).
| Nama tetapan tapak | Penerangan |
|---|---|
| Webapi/<table name>/enabled | Mendayakan atau menyahdayakan API Web untuk <nama jadual>. Lalai: False Nilai yang sah: True, False |
| Webapi/<table name>/fields | Mentakrifkan senarai atribut dipisahkan koma yang boleh diubah suai dengan API Web. Nilai yang mungkin: - Semua atribut: * - Atribut khusus: attr1,attr2,attr3 Nota: Nilai tersebut mesti sama ada asterisk (*) atau senarai nama medan dipisahkan koma. Penting: Ini ialah tetapan tapak mandatori. Apabila tetapan ini hilang, anda akan melihat ralat "Tiada medan yang ditakrifkan untuk entiti ini." |
| Webapi/error/innererror | Mendayakan atau menyahdayakan RalatDalaman. Lalai: False Nilai yang sah: True, False |
| Webapi/<table name>/disableodatafilter | Mendayakan atau menyahdayakan penapis OData. Lalai: False Nilai yang sah True, False Lihat isu diketahui untuk maklumat lanjut. Tetapan tapak tersedia dalam versi portal 9.4.10.74 atau lebih baharu. |
Nota
Tetapan tapak mesti ditetapkan kepada Aktif untuk perubahan berkuat kuasa.
Sebagai contoh, untuk mendedahkan API Web untuk jadual Kes di mana pengguna yang disahkan dibenarkan untuk melaksanakan mencipta, mengemas kini dan memadam operasi pada entiti ini, tetapan tapak ditunjukkan dalam jadual berikut.
| Nama tetapan tapak | Nilai tetapan tapak |
|---|---|
| Webapi/incident/enabled | benar |
| Webapi/incident/fields | attr1, attr2, attr3 |
Keselamatan dengan API Web portal
Anda boleh mengkonfigurasi keselamatan berdasarkan rekod kepada rekod individu dalam portal dengan menggunakan jadual keizinan. API Web portal mengakses jadual (entiti) rekod mengikut keizinan jadual yang diberikan kepada pengguna melalui yang berkaitan peranan web.
Anda boleh mengkonfigurasi keizinan lajur untuk mentakrifkan lagi kelayakan pada lajur individu dalam jadual ketika menggunakan API Web portal.
Mengesahkan permintaan API Web portal
Anda tidak perlu memasukkan kod pengesahan, kerana pengesahan dan pengesahan diuruskan oleh sesi aplikasi. Semua panggilan API Web mesti mengandungi token Pemalsuan Permintaan Merentasi Tapak (CSRF).
Menggunakan EntitySetName
Apabila merujuk kepada jadual Dataverse menggunakan API Web portal dalam kod anda, anda perlu menggunakan EntitySetName, sebagai contoh, untuk mengakses jadual akaun, sintaks kod akan menggunakan EntitySetName akaun;/_api/accounts().
Nota
Gunakan nama logik jadual untuk tetapan tapak (sebagai contoh, akaun).
Anda boleh menentukan EntitySetName jadual khusus dengan mengikut langkah berikut:
Pergi ke https://make.powerapps.com
Pilih tab Dataverse daripada panel tepi dan pilih jadual.
Pilih ... (Pilihan perintah) dan kemudian pilih Lanjutan, Alat, dan Salin nama set untuk menyalin EntitySetName jadual kepada papan klip anda.
Undang-undang dan peraturan privasi
Semua pengepala permintaan akan mempunyai ID kenalan yang diluluskan untuk tujuan pengauditan. Untuk pengguna tanpa nama, ini akan diluluskan sebagai null.
Jika log audit didayakan, pengguna boleh melihat semua peristiwa audit dalam Office 365 log audit.
Maklumat lanjut:
Mendayakan dan menggunakan pengelogan aktiviti
Eksport, konfigurasi dan rekod log audit pandangan
Jadual konfigurasi tidak disokong
API Web Portal tidak boleh digunakan untuk jadual konfigurasi berikut:
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
Isu yang diketahui
Pengguna akan mendapat ralat CDS jika mereka memohon GET permintaan API Web untuk jadual yang mempunyai berbilang aras 1 hingga banyak atau banyakkeizinan jadual apabila skop Parental,Hubungi atauAkaun menambah syarat tambahan kepada pertanyaan.
Untuk menyelesaikan isu ini, penyelesaian yang disyorkan ialah menggunakan FetchXML dalam pertanyaan OData.
Secara laternatif, tetapkan tetapan tapak Webapi/<table name>/disableodatafilter kepada True.
Penting
Menukar tetapan tapak Webapi/<table name>/disableodatafilter kepada True boleh mengakibatkan prestasi yang lebih perlahan untuk API Web panggilan GET.
Tetapan tapak tersedia dalam versi portal 9.4.10.74 atau lebih baharu.
Langkah seterusnya
Pertanyaan data menggunakan API Web portal