Tổng quan API web cổng thông tin
Lưu ý
Từ ngày 12 tháng 10 năm 2022, cổng thông tin Power Apps sẽ trở thành Power Pages. Thông tin khác: Microsoft Power Pages hiện đã được phát hành rộng rãi (blog)
Chúng tôi sẽ sớm di chuyển và hợp nhất hướng dẫn sử dụng cổng thông tin Power Apps với hướng dẫn sử dụng Power Pages.
API Web cổng thông tin hỗ trợ trải nghiệm người dùng đa dạng hơn trong các trang cổng thông tin Power Apps. Bạn có thể sử dụng API web để thực hiện các thao tác tạo, đọc, cập nhật và xóa trên tất cả các bảng Microsoft Dataverse ở các trang cổng thông tin của bạn. Chẳng hạn, bạn có thể tạo tài khoản mới, cập nhật người liên hệ hoặc thay đổi quyền đối với bảng cho một sản phẩm bằng API web cổng thay vì ứng dụng Quản lý cổng thông tin.
Lưu ý
Bạn cũng có thể sử dụng API web cổng thông tin trong Power Pages. Thông tin thêm: Power Pages là gì
Quan trọng
- Phiên bản cổng thông tin của bạn phải từ 9.3.3.x trở lên để tính năng này hoạt động.
- API Web cổng thông tin được xây dựng để tạo trải nghiệm người dùng đa dạng trong các trang cổng thông tin. Nó không được tối ưu hóa cho các dịch vụ của bên thứ ba hoặc tích hợp ứng dụng. Việc sử dụng API Web cổng thông tin để tích hợp với các trang cổng thông tin Power Apps khác hiện cũng chưa được hỗ trợ.
- Các thao tác trên API web của cổng thông tin được giới hạn trong phạm vi các bảng liên quan đến dữ liệu, ví dụ: tài khoản, người liên hệ hoặc bảng tùy chỉnh của bạn. Hoạt động đặt cấu hình siêu dữ liệu bảng hoặc dữ liệu bảng cấu hình cổng thông tin, ví dụ: đặt cấu hình các bảng cổng thông tin như adx_contentsnippet, adx_entityform hoặc adx_entitylist, không được hỗ trợ với API web của cổng thông tin. Để xem danh sách hoàn chỉnh, hãy chuyển đến bảng cấu hình không được hỗ trợ ở phần sau của chủ đề này.
- API Web cổng thông tin được hưởng lợi từ bộ nhớ đệm phía máy chủ, nên các lệnh gọi tiếp theo tới API Web nhanh hơn các lệnh gọi ban đầu. Lưu ý rằng việc xóa bộ đệm phía máy chủ cổng thông tin sẽ gây ra sự suy giảm hiệu suất tạm thời.
- Các hoạt động API web cổng thông tin yêu cầu giấy phép cổng thông tin Power Apps. Ví dụ: các lệnh gọi API Web do người dùng ẩn danh thực hiện được tính vào dung lượng xem trang. Các lệnh gọi API web do người dùng đã xác thực (nội bộ hoặc bên ngoài) thực hiện không được tính vào lượt xem trang, nhưng yêu cầu giấy phép hiện hành. Thông tin thêm: Câu hỏi thường gặp về giấy phép cổng thông tin Power Apps
Các thao tác API Web
API Web cổng thông tin cung cấp một tập hợp con các khả năng cho hoạt động Dataverse mà bạn có thể thực hiện bằng cách sử dụng API Dataverse. Chúng tôi đã giữ định dạng API giống nhất có thể để giảm tốc độ lĩnh hội.
Lưu ý
Các thao tác API web phân biệt chữ hoa chữ thường.
Các thao tác API Web có trong cổng thông tin
- Đọc bản ghi từ một bảng
- Tạo bản ghi trong bảng
- Cập nhật và xóa bản ghi trong bảng
- Liên kết và hủy liên kết bảng
Thiết đặt trang web cho API Web
Bạn phải bật thiết đặt trang web để bật API Web cổng thông tin cho cổng thông tin của mình. Bạn cũng có thể đặt cấu hình API web ở cấp độ trường để xác định việc có thể sửa đổi các trường trong bảng bằng API web của cổng thông tin hay không.
Lưu ý
Sử dụng bảng tên logic cho các cài đặt này (ví dụ: tài khoản).
Tên thiết đặt trang web | Description |
---|---|
Webapi/<table name>/enabled | Bật hoặc tắt API Web cho <table name>. Mặc định: False Giá trị hợp lệ: True , False |
Webapi/<table name>/fields | Xác định danh sách các thuộc tính được phân tách bằng dấu phẩy có thể được sửa đổi bằng API Web. Giá trị có thể dùng: - Tất cả thuộc tính: * - Thuộc tính cụ thể: attr1,attr2,attr3 Ghi chú: Giá trị phải là danh sách tên trường được phân tách bằng dấu hoa thị (*) hoặc dấu phẩy. Quan trọng: Đây là thiết đặt trang web bắt buộc. Khi thiếu cài đặt này, bạn sẽ thấy lỗi "Không có trường nào được xác định cho thực thể này". |
Webapi/error/innererror | Bật hoặc tắt lỗi bên trong. Mặc định: False Giá trị hợp lệ: True , False |
Webapi/<table name>/disableodatafilter | Bật hoặc tắt bộc lọc OData. Mặc định: False Giá trị hợp lệ: True , False Xem sự cố đã biết để tìm hiểu thêm thông tin. Cài đặt trang web có sẵn trong phiên bản cổng thông tin 9.4.10.74 trở lên. |
Lưu ý
Bạn phải đặt thiết đặt site thành Hiện hoạt thì các thay đổi mới có hiệu lực.
Chẳng hạn, để hiển thị API web cho bảng Trường hợp mà người dùng đã xác thực được phép thực hiện các thao tác tạo, cập nhật và xóa trên đó, phần thiết đặt trang được hiển thị trong bảng sau.
Tên thiết đặt trang web | Giá trị thiết đặt trang web |
---|---|
Webapi/incident/enabled | đúng |
Webapi/incident/fields | attr1, attr2, attr3 |
Bảo mật với API Web cổng thông tin
Bạn có thể đặt cấu hình tùy chọn bảo mật dựa trên bản ghi cho các bản ghi riêng lẻ trong cổng thông bằng quyền đối với bảng. API web của cổng thông tin truy nhập các bản ghi bảng (thực thể) và tuân theo các quyền đối với bảng được cấp cho người dùng thông qua vai trò web được liên kết.
Bạn có thể đặt cấu hình quyền đối với cột để xác định thêm các đặc quyền cho các cột riêng lẻ trong một bảng trong khi sử dụng API web cổng thông tin.
Xác thực các yêu cầu của API Web cổng thông tin
Bạn không cần phải bao gồm mã xác thực, vì xác thực và ủy quyền được quản lý bởi phiên ứng dụng. Tất cả các lệnh gọi API Web phải bao gồm mã thông báo Giả mạo yêu cầu chèn trang (CSRF).
Dùng EntitySetName
Khi tham chiếu đến bảng Dataverse sử dụng API web cổng thông tin trong mã, bạn cần sử dụng EntitySetName, ví dụ như để truy cập vào bảng tài khoản, cú pháp mã sẽ sử dụng EntitySetName của tài khoản; /_api/accounts()
.
Lưu ý
Sử dụng bảng tên logic của bảng cho phần cài đặt trang (ví dụ: tài khoản).
Bạn có thể xác định EntitySetName của các bảng cụ thể bằng cách làm theo các bước sau:
Chuyển tới https://make.powerapps.com
Chọn tab Dataverse từ bảng điều khiển bên và chọn bảng.
Chọn ... (Tùy chọn lệnh), sau đó chọn Nâng cao, Công cụ và Sao chép tên nhóm để sao chép EntitySetName của bảng vào khay nhớ tạm của bạn.
Quy định chung về bảo vệ dữ liệu (GDPR)
Tất cả các tiêu đề yêu cầu sẽ có một ID liên hệ được chuyển cho mục đích kiểm tra. Đối với người dùng ẩn danh, ID này sẽ được chuyển dưới dạng null
.
Nếu ghi nhật ký kiểm tra được bật, người dùng có thể xem tất cả các sự kiện kiểm tra trong nhật ký kiểm tra Office 365.
Thông tin khác:
Bật và sử dụng chức năng ghi nhật ký hoạt động
Xuất, định cấu hình và xem các bản ghi nhật ký kiểm tra
Bảng cấu hình không được hỗ trợ
Không thể sử dụng API web của cổng thông tin cho các bảng cấu hình sau:
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
Các vấn đề đã biết
Người dùng sẽ gặp lỗi CDS nếu họ gọi yêu cầu API web GET
cho các bảng có nhiều cấp độ 1 đến nhiều hoặc nhiều đến nhiều quyền đối với bảng với phạm vi mẹ đã xác định.
Để giải quyết vấn đề này, giải pháp được khuyến nghị là sử dụng FetchXML trong truy vấn OData.
Hoặc thiết lập cài đặt trang Webapi/<table name>/disableodatafilter thành True
.
Quan trọng
Thay đổi cài đặt trang Webapi/<table name>/disableodatafilter thành True
có thể dẫn đến hiệu suất chậm hơn đối với các lệnh gọi API web GET
.
Cài đặt trang web có sẵn trong phiên bản cổng thông tin 9.4.10.74 trở lên.
Bước tiếp theo
Truy vấn dữ liệu bằng API Web cổng thông tin
Xem thêm
Soạn các yêu cầu HTTP và xử lý lỗi
Thao tác ghi, cập nhật và xóa cổng thông tin bằng Web API
Hướng dẫn: Sử dụng API web cổng thông tin
Lưu ý
Bạn có thể cho chúng tôi biết bạn thích dùng ngôn ngữ nào cho tài liệu không? Làm một cuộc khảo sát ngắn. (xin lưu ý, khảo sát này bằng tiếng Anh)
Cuộc khảo sát sẽ mất khoảng bảy phút. Không có dữ liệu cá nhân nào được thu thập (điều khoản về quyền riêng tư).