Ikhtisar API Web portal
API web portal memungkinkan untuk pengalaman pengguna yang lebih kaya dalam situs Power Pages. Anda dapat menggunakan API Web untuk melakukan operasi buat, baca, perbarui, dan hapus di semua tabel Microsoft Dataverse dari halaman web Anda. Contohnya, Anda dapat membuat akun baru, memperbarui kontak , tanpa menggunakan formulir atau formulir multilangkah menggunakan API Web portal.
Penting
- Versi situs Power Pages Anda harus 9.3.3.x atau versi yang lebih baru agar fitur ini berfungsi.
- API web portal dibuat untuk membuat pengalaman pengguna yang lebih kaya dalam halaman portal. Tidak dioptimalkan untuk layanan pihak ketiga atau integrasi aplikasi. Menggunakan API Web portal untuk diintegrasikan dengan situs Power Pages lain juga tidak didukung.
- Operasi API Web portal terbatas ke tabel yang terkait dengan data—misalnya, akun, kontak, atau tabel kustom Anda. Mengkonfigurasi metadata tabel atau data tabel konfigurasi portal—misalnya, mengkonfigurasi tabel portal seperti adx_contentsnippet, adx_entityform, atau adx_entitylist—tidak didukung dengan API Web portal. Untuk daftar lengkap, buka tabel konfigurasi yang tidak didukung, nanti di topik ini.
- API web portal mendapatkan keuntungan dari caching sisi server sehingga panggilan berikutnya ke web api lebih cepat daripada panggilan awal. Perhatikan bahwa membersihkan cache sisi server portal menyebabkan penurunan kinerja sementara.
- Operasi Web API portal memerlukan lisensi Power Pages. Misalnya, panggilan Web API yang dilakukan oleh pengguna anonim dihitung terhadap kapasitas pengguna anonim. Panggilan API Web yang dilakukan oleh pengguna terotentikasi (internal atau eksternal) tidak dihitung terhadap tampilan halaman, namun memerlukan lisensi kapasitas pengguna yang diautentikasi. Informasi selengkapnya: Tanya Jawab Lisensi Power Pages
Operasi Web API
API web portal menawarkan subset kemampuan untuk operasi Dataverse yang dapat Anda lakukan menggunakan API Dataverse. Kami telah menyimpan format API seserupa mungkin, untuk mengurangi kurva pembelajaran.
Catatan
Operasi web API peka huruf besar/kecil.
Operasi API web tersedia di di Power Pages
- Membaca rekaman dari tabel
- Membuat rekaman dalam tabel
- Memperbarui dan menghapus rekaman dalam tabel
- Mengaitkan dan memisahkan tabel
Pengaturan situs untuk web API
Anda harus mengaktifkan pengaturan lokasi untuk mengaktifkan portal web API untuk portal Anda. Anda juga dapat mengkonfigurasi API Web tingkat bidang yang menentukan bidang tabel yang dapat atau tidak dapat dimodifikasi dengan API Web portal.
Catatan
Gunakan nama logika tabel untuk pengaturan ini (misalnya akun).
| Nama Pengaturan Situs | Deskripsi |
|---|---|
| Webapi/<table name>/enabled | Mengaktifkan atau menonaktifkan untuk <nama tabel>. Default: False Nilai Valid: True, False |
| Webapi/<table name>/fields | Menentukan daftar atribut yang dipisahkan koma yang dapat dimodifikasi dengan web API. Nilai yang mungkin: - Semua atribut: * - Atribut tertentu: attr1,attr2,attr3 Catatan: nilai harus berupa tanda bintang (*) atau daftar nama bidang yang dipisahkan koma. Penting: Ini adalah pengaturan situs wajib. Bila pengaturan ini tidak ada, Anda akan melihat kesalahan "tidak ada bidang yang ditentukan untuk entitas ini". |
| Webapi/error/innererror | Mengaktifkan atau menonaktifkan InnerError. Default: False Nilai Valid: True, False |
| Webapi/<table name>/disableodatafilter | Mengaktifkan atau menonaktifkan file OData. Default: False Nilai yang valid: True, False Lihat masalah umum untuk informasi lebih lanjut. Pengaturan situs tersedia di versi portal 9.4.10.74 atau yang lebih baru. |
Catatan
Pengaturan situs harus diatur ke aktif agar perubahan diterapkan.
Contohnya, untuk mengekspos API Web untuk tabel Kasus di mana pengguna terotentikasi diizinkan untuk melakukan operasi pembuatan, pembaruan, dan penghapusan pada entitas ini, pengaturan situs ditampilkan dalam tabel berikut.
| Nama Pengaturan Situs | Nilai pengaturan Situs |
|---|---|
| Webapi/incident/enabled | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
Keamanan dengan API web portal
Anda dapat mengkonfigurasi keamanan berbasis rekaman ke rekaman individual di portal menggunakan izin tabel. API Web portal mengakses rekaman (entitas) dan mengikuti izin tabel yang diberikan kepada pengguna melalui peran web terkait.
Anda dapat mengkonfigurasi izin kolom untuk menentukan lebih lanjut hak istimewa ke masing-masing kolom dalam tabel saat menggunakan API Web portal.
Mengautentikasi permintaan API web portal
Anda tidak perlu menyertakan kode otentikasi, karena autentikasi dan otorisasi dikelola oleh sesi aplikasi. Semua panggilan API web harus mencakup token permintaan pemalsuan permintaan lintas situs (CSRF).
menggunakan EntitySetName
Bila merujuk ke tabel Dataverse menggunakan API Web portal di kode Anda, Anda harus menggunakan EntitySetName, contohnya,untuk mengakses tabel akun, sintaks kode akan menggunakan EntitySetName dari akun; /_api/accounts().
Catatan
Gunakan nama logika tabel untuk pengaturan situs ini (misalnya akun).
Anda dapat menentukan EntitySetName dari tabel tertentu dengan mengikuti langkah-langkah berikut:
Pilih tab Dataverse dari panel sisi, lalu pilih tabel.
Pilih ... (Pilihan perintah) dan kemudian pilih Tingkat Lanjut, Alat, dan Salin nama rangkaian untuk menyalin EntitySetName dari tabel ke clipboard.
Undang-undang dan peraturan privasi
Semua header permintaan akan memiliki ID kontak yang diteruskan untuk tujuan audit. Untuk pengguna anonim, ini akan diteruskan sebagai null.
Jika pendataan audit diaktifkan, pengguna dapat melihat semua aktivitas audit dalam log audit Office 365.
Informasi selengkapnya:
Mengaktifkan dan menggunakan pencatatan aktivitas
Ekspor, konfigurasi, dan lihat rekaman log audit
Tabel konfigurasi yang tidak didukung.
API Web Portal tidak dapat digunakan untuk tabel 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
Masalah yang diketahui
Pengguna akan mendapatkan kesalahan CDS jika mereka memanggil GET permintaan API Web untuk tabel yang memiliki beberapa tingkat 1 hingga banyak atau banyak izin tabel saat cakupan Parental, Kontak , atau Akun menambahkan kondisi tambahan ke kueri.
Untuk menangani masalah ini, solusi yang disarankan adalah menggunakan FetchXML di kueri OData.
Atau, atur pengaturan situs Webapi/<table name>/disableodatafilter ke True.
Penting
Mengubah pengaturan situs Webapi/<table name>/disableodatafilter ke True dapat mengakibatkan kinerja lebih lambat untuk panggilan GET Web API.
Pengaturan situs tersedia di versi portal 9.4.10.74 atau yang lebih baru.
Langkah selanjutnya
Data kueri menggunakan API Web portal