ภาพรวมของ API เว็บของพอร์ทัล
Web API ของพอร์ทัลช่วยให้สร้างประสบการณ์ผู้ใช้ที่สมบูรณ์ยิ่งขึ้นภายในหน้าพอร์ทัลของ Power Apps คุณสามารถใช้ Web API เพื่อทำการสร้าง, อ่าน, อัปเดต, และลบการดำเนินการในตาราง Microsoft Dataverse ทั้งหมดจากหน้าพอร์ทัลของคุณ ตัวอย่างเช่น คุณสามารถสร้างบัญชีใหม่ อัปเดตผู้ติดต่อ หรือเปลี่ยน สิทธิ์ในตาราง สำหรับผลิตภัณฑ์โดยใช้ API เว็บของพอร์ทัลแทนแอปการจัดการพอร์ทัล
ข้อสำคัญ
- รุ่นพอร์ทัลของคุณต้องเป็น 9.3.3.x หรือใหม่กว่าเพื่อให้คุณลักษณะนี้ทำงานได้
- Web API ของพอร์ทัลถูกสร้างเพื่อสร้างประสบการณ์ผู้ใช้ที่สมบูรณ์ยิ่งขึ้นภายในหน้าพอร์ทัล ไม่เหมาะสำหรับบริการของบุคคลที่สาม หรือการรวมโปรแกรมประยุกต์
- การดำเนินการ API เว็บของพอร์ทัลจำกัดเฉพาะตารางที่เกี่ยวข้องกับข้อมูล—ตัวอย่างเช่น บัญชี ผู้ติดต่อ หรือตารางที่คุณกำหนดเอง การกำหนดค่าข้อมูลเมตาของตารางหรือข้อมูลตารางการกำหนดค่าของพอร์ทัล—ตัวอย่างเช่น การกำหนดค่าตารางพอร์ทัล เช่น adx_contentsnippet, adx_entityform หรือ adx_entitylist—ไม่รองรับ API เว็บของพอร์ทัล สำหรับรายการทั้งหมด ไปที่ ตารางการตั้งค่าคอนฟิกที่ไม่รองรับ ต่อไปในหัวข้อนี้
- Web API ของพอร์ทัลได้รับประโยชน์จาก การแคชฝั่งเซิร์ฟเวอร์ ดังนั้น การเรียกไปยัง Web API ในภายหลังจึงเร็วกว่าการเรียกครั้งแรก โปรดทราบว่าการล้างแคชฝั่งเซิร์ฟเวอร์ของพอร์ทัลจะทำให้ประสิทธิภาพลดลงชั่วคราว
- การดำเนินการ Web API ของพอร์ทัลต้องการสิทธิ์การใช้งานพอร์ทัลของ Power Apps ตัวอย่างเช่น การเรียก API สำหรับเว็บที่ทำโดยผู้ใช้ที่ไม่ระบุชื่อจะนับรวมกับความสามารถที่รองรับการดูเพจ การเรียก API สำหรับเว็บที่ทำโดยผู้ใช้ที่ได้รับการรับรองความถูกต้อง (ภายในหรือภายนอก) จะไม่นับรวมในการดูเพจ แต่ต้องมีใบอนุญาตที่ใช้งานได้ ข้อมูลเพิ่มเติม: คำถามที่พบบ่อยเกี่ยวกับการอนุญาตให้ใช้สิทธิ์พอร์ทัล Power Apps
การดำเนินการของ Web API
Web API ของพอร์ทัลมีความสามารถย่อยสำหรับการดำเนินการ Dataverse ที่คุณสามารถทำได้โดยใช้ API ของ Dataverse เรายังคงรักษารูปแบบ API ให้ใกล้เคียงกันมากที่สุด เพื่อลดช่วงการเรียนรู้
การดำเนินการของ Web API พร้อมใช้งานในพอร์ทัล
การตั้งค่าไซต์สำหรับ Web API
คุณต้องเปิดใช้งานการตั้งค่าไซต์เพื่อเปิดใช้งาน Web API ของพอร์ทัลสำหรับพอร์ทัลของคุณ นอกจากนี้ คุณยังสามารถตั้งค่าคอนฟิก Web API ระดับฟิลด์ที่กำหนดฟิลด์ตารางที่สามารถหรือไม่สามารถแก้ไขได้ด้วย Web API ของพอร์ทัล
| ชื่อการตั้งค่าไซต์ | รายละเอียด |
|---|---|
| Webapi/<table name>/enabled | เปิดหรือปิดใช้งาน Web API สำหรับ <table name> ค่าเริ่มต้น: False ค่าที่ถูกต้อง: True False |
| Webapi/<table name>/fields | กำหนดรายการแอตทริบิวต์ที่คั่นด้วยจุลภาคที่สามารถแก้ไขได้ด้วย Web API ค่าที่เป็นไปได้: - แอตทริบิวต์ทั้งหมด: * - แอตทริบิวต์เฉพาะ: attr1,attr2,attr3 หมายเหตุ: ค่าต้องเป็นเครื่องหมายดอกจัน (*_) หรือรายการชื่อฟิลด์ที่คั่นด้วยจุลภาค _ สิ่งสำคัญ: นี่เป็นการตั้งค่าไซต์บังคับ เมื่อการตั้งค่านี้หายไป คุณจะเห็นข้อผิดพลาด "ไม่ได้กำหนดฟิลด์สำหรับเอนทิตีนี้" |
| Webapi/ข้อผิดพลาด/innererror | เปิดใช้งานหรือปิดใช้งาน InnerError ค่าเริ่มต้น: False ค่าที่ถูกต้อง: True False |
หมายเหตุ
การตั้งค่าไซต์จะต้องตั้งค่าเป็น ใช้งานอยู่ เพื่อให้การเปลี่ยนแปลงมีผล
ตัวอย่างเช่น เพื่อแสดง API สำหรับเว็บสำหรับตาราง Case ที่ผู้ใช้ที่ได้รับการรับรองความถูกต้องได้รับอนุญาตให้ดำเนินการสร้าง อัปเดต และลบการดำเนินการในเอนทิตีนี้ การตั้งค่าไซต์จะแสดงในตารางต่อไปนี้
| ชื่อการตั้งค่าไซต์ | ค่าการตั้งค่าไซต์ |
|---|---|
| Webapi/เหตุการณ์/เปิดใช้งาน | จริง |
| Webapi/เหตุการณ์/ฟิลด์ | attr1,attr2,attr3 |
การรักษาความปลอดภัยด้วย Web API ของพอร์ทัล
คุณสามารถกำหนดค่าการรักษาความปลอดภัยตามเรกคอร์ดให้กับแต่ละเรกคอร์ดในพอร์ทัลได้โดยใช้ สิทธิ์ในตาราง Web API ของพอร์ทัลเข้าถึงเรกคอร์ดตาราง (เอนทิตี) และติดตามสิทธิ์ของตารางที่มอบให้กับผู้ใช้ผ่าน บทบาทเว็บ ที่เกี่ยวข้อง
การรับรองความถูกต้องคำขอ Web API ของพอร์ทัล
คุณไม่จำเป็นต้องใส่รหัสการรับรองความถูกต้อง เนื่องจากการอนุญาตและการรับรองความถูกต้องได้รับการจัดการโดยเซสชันแอปพลิเคชัน การเรียกใช้ Web API ทั้งหมดต้องมีโทเค็นการปลอมแปลงคำขอข้ามไซต์ (CSRF)
ข้อบังคับในการป้องกันข้อมูลทั่วไป (GDPR)
ส่วนหัวของคำขอทั้งหมดจะมีการส่งรหัสผู้ติดต่อเพื่อการตรวจสอบ สำหรับผู้ใช้ที่ไม่ระบุชื่อ สิ่งนี้จะถูกส่งผ่านเป็น null
หากเปิดใช้งานการบันทึกการตรวจสอบ ผู้ใช้สามารถดูเหตุการณ์การตรวจสอบทั้งหมดใน บันทึกการตรวจสอบ Office 365
ข้อมูลเพิ่มเติม:
เปิดใช้งาน และใช้การบันทึกกิจกรรม
ส่งออก, ตั้งค่าคอนฟิก, และดูเรกคอร์ดบันทึกการตรวจสอบ
ตารางการกำหนดค่าที่ไม่รองรับ
Web API ของพอร์ทัลไม่สามารถใช้สำหรับตารางการตั้งค่าคอนฟิกต่อไปนี้:
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
ขั้นตอนถัดไป
สืบค้นข้อมูลโดยใช้ Web API ของพอร์ทัล
(ดูเพิ่มเติม )
เขียนคำขอ HTTP และจัดการข้อผิดพลาด พอร์ทัลเขียน, ปรับปรุง, และลบการดำเนินงานโดยใช้ Web API บทช่วยสอน: ใช้ Web API ของพอร์ทัล