Επισκόπηση πυλών Web API
Το API Web πυλών επιτρέπει μια πιο πλούσια εμπειρία χρήστη μέσα σε τοποθεσίες Power Pages. Μπορείτε να χρησιμοποιείτε τα Web ΑΡΙ για λειτουργίες δημιουργίας, ανάγνωσης, ενημέρωσης και διαγραφής σε όλους τους πίνακες Microsoft Dataverse από τις ιστοσελίδες σας. Για παράδειγμα, μπορείτε να δημιουργήσετε έναν νέο λογαριασμό, να ενημερώσετε μια επαφή, χωρίς να χρησιμοποιήσετε φόρμα ή φόρμα πολλών βημάτων χρησιμοποιώντας το API Web των πυλών.
Σημαντικό
- Η έκδοση της τοποθεσίας σας Power Pages πρέπει να είναι 9.3.3.x ή μεταγενέστερη προκειμένου να λειτουργεί αυτή η δυνατότητα.
- Το Web API πυλών έχει δημιουργηθεί για τη δημιουργία μιας πλουσιότερης εμπειρίας χρήστη μέσα από τις σελίδες των πυλών. Δεν έχει βελτιστοποιηθεί για υπηρεσίες τρίτων κατασκευαστών ή για ενοποίηση εφαρμογών. Δεν υποστηρίζεται επίσης η χρήση του API Web πυλών για ενοποίηση με άλλες τοποθεσίες Power Pages.
- Οι λειτουργίες API web των πυλών περιορίζονται σε πίνακες που σχετίζονται με δεδομένα, για παράδειγμα, σε λογαριασμούς, επαφές ή στους προσαρμοσμένους πίνακες σας. Για παράδειγμα, η ρύθμιση παραμέτρων δεδομένων μετα-δεδομένων πίνακα ή πίνακα ρύθμισης παραμέτρων πύλης, για παράδειγμα ρύθμιση παραμέτρων πινάκων πυλών, όπως adx_contentsnippet, adx_entityform ή adx_entitylist, δεν υποστηρίζεται στο API Web των πυλών. Για μια πλήρη λίστα, μεταβείτε στους μη υποστηριζόμενους πίνακες ρύθμισης στη συνέχεια αυτού του θέματος.
- Το Web API για τις πύλες ωφελείται από την προσωρινή αποθήκευση στο διακομιστή, επομένως οι επόμενες κλήσεις στο Web ΑΡΙ είναι ταχύτερες από τις αρχικές κλήσεις. Λάβετε υπόψη σας ότι η κατάργηση της προσωρινής μνήμης cache του διακομιστή πύλης προκαλεί την προσωρινή υποβάθμιση των επιδόσεων.
- Οι λειτουργίες Web API πυλών απαιτούν άδεια χρήσης Power Pages. Για παράδειγμα, οι κλήσεις ΑΡΙ Web που πραγματοποιούνται από ανώνυμους χρήστες υπολογίζονται ως προς την παραγωγική ικανότητα ανώνυμου χρήστη. Οι κλήσεις API Web που πραγματοποιούνται από χρήστες που έχουν υποβληθεί σε έλεγχο ταυτότητας (εσωτερικές ή εξωτερικές) δεν μετρώνται στις προβολές σελίδων, αλλά απαιτούν ισχύουσες άδειες χρήσης παραγωγικής ικανότητας χρήστη. Περισσότερες πληροφορίες: Συχνές ερωτήσεις για άδειες χρήσης του Power Pages
Λειτουργίες Web API
Το Web API πυλών προσφέρει ένα υποσύνολο δυνατοτήτων για τις λειτουργίες του Dataverse που μπορείτε να πραγματοποιήσετε χρησιμοποιώντας το Dataverse API. Κρατήσαμε τη μορφή API όσο το δυνατόν πιο παρόμοια για να μειώσουμε την καμπύλη εκμάθησης.
Σημείωμα
Οι λειτουργίες WEB API έχουν διάκριση πεζών-κεφαλαίων.
Λειτουργίες Web API που είναι διαθέσιμες στο Power Pages
- Ανάγνωση καρτελών από έναν πίνακα
- Δημιουργία καρτέλας σε πίνακα
- Ενημέρωση και διαγραφή καρτελών σε πίνακα
- Συσχέτιση και κατάργηση συσχέτισης πινάκων
Σημείωμα
Η κλήση ενεργειών και συναρτήσεων με χρήση του API Web πυλών δεν υποστηρίζεται.
Ρυθμίσεις τοποθεσίας για το Web API
Πρέπει να ενεργοποιήσετε τη ρύθμιση τοποθεσίας για να ενεργοποιήσετε το Web API πυλών για την πύλη σας. Μπορείτε επίσης να ρυθμίσετε τις παραμέτρους του Web ΑΡΙ σε επίπεδο πεδίου, το οποίο καθορίζει τα πεδία πίνακα που μπορούν ή δεν μπορούν να τροποποιηθούν με το Web API των πυλών.
Σημείωμα
Χρησιμοποιήστε το λογικό όνομα πίνακα για αυτές τις ρυθμίσεις (για παράδειγμα λογαριασμός).
| Όνομα ρύθμισης τοποθεσίας | Description |
|---|---|
| Webapi/<table name>/enabled | Ενεργοποιεί ή απενεργοποιεί το API Web για το <table name>. Προεπιλογή: False Έγκυρες τιμές: True, False |
| Webapi/<table name>/fields | Καθορίζει τη λίστα διαχωρισμένων με κόμματα των χαρακτηριστικών που μπορούν να τροποποιηθούν με το Web API. Πιθανές τιμές: - Όλα τα χαρακτηριστικά: * - Συγκεκριμένα χαρακτηριστικά: attr1,attr2,attr3 Σημείωση: η τιμή πρέπει να είναι είτε ένας αστερίσκος (*) είτε μια λίστα με ονόματα πεδίων που διαχωρίζονται με κόμματα. Σημαντικό: πρόκειται για μια υποχρεωτική ρύθμιση τοποθεσίας. Όταν λείπει αυτή η ρύθμιση, θα εμφανιστεί το σφάλμα "Δεν έχουν καθοριστεί πεδία για αυτήν την οντότητα". |
| Webapi/error/innererror | Ενεργοποιεί ή απενεργοποιεί το InnerError. Προεπιλογή: False Έγκυρες τιμές: True, False |
| Webapi/<table name>/disableodatafilter | Ενεργοποιεί ή απενεργοποιεί το φίλτρο Odata. Προεπιλογή: False Έγκυρες τιμές: True, False Δείτε γνωστά προβλήματα για περισσότερες πληροφορίες. Η ρύθμιση τοποθεσίας είναι διαθέσιμη στην έκδοση πύλης 9.4.10.74 ή μεταγενέστερη έκδοση. |
Σημείωμα
Οι ρυθμίσεις τοποθεσίας πρέπει να έχουν οριστεί σε Ενεργή για να εφαρμοστούν οι αλλαγές.
Για παράδειγμα, για να αποκαλυφθεί το ΑΡΙ Web για τον πίνακα Υπόθεση, όπου επιτρέπεται στους χρήστες που έχουν υποβληθεί σε έλεγχο ταυτότητας να εκτελούν λειτουργίες δημιουργίας, ενημέρωσης και διαγραφής σε αυτήν την οντότητα, οι ρυθμίσεις τοποθεσίας εμφανίζονται στον ακόλουθο πίνακα.
| Όνομα ρύθμισης τοποθεσίας | Τιμή ρύθμισης τοποθεσίας |
|---|---|
| Webapi/incident/enabled | αληθής |
| Webapi/incident/fields | attr1, attr2, attr3 |
Ασφάλεια με το Web API πυλών
Μπορείτε να ρυθμίσετε τις παραμέτρους ασφάλειας που βασίζεται σε καρτέλες σε μεμονωμένες καρτέλες στις πύλες χρησιμοποιώντας δικαιώματα πινάκων. Τα Web ΑΡΙ πυλών έχουν πρόσβαση σε καρτέλες πίνακα (οντότητας) και ακολουθούν τα δικαιώματα πίνακα που δίνονται στους χρήστες μέσω των συσχετισμένων ρόλων web.
Μπορείτε να ρυθμίσετε τις παραμέτρους των δικαιωμάτων στηλών για να καθορίσετε περαιτέρω τα δικαιώματα σε μεμονωμένες στήλες μέσα σε έναν πίνακα κατά τη χρήση του Web API πυλών.
Έλεγχος ταυτότητας αιτημάτων Web API πυλών
Δεν χρειάζεται να συμπεριλάβετε έναν κωδικό ελέγχου ταυτότητας, επειδή ο έλεγχος ταυτότητας και η εξουσιοδότηση διαχειρίζονται από την περίοδο λειτουργίας της εφαρμογής. Όλες οι κλήσεις Web API πρέπει να περιλαμβάνουν ένα διακριτικό πλαστογράφησης αιτήματος μεταξύ τοποθεσιών (CSRF).
Χρήση του EntitySetName
Όταν αναφέρεστε σε πίνακες Dataverse που χρησιμοποιούν το API Web πυλών στον κώδικά σας, πρέπει να χρησιμοποιήσετε το EntitySetName, για παράδειγμα, για να αποκτήσετε πρόσβαση στον πίνακα λογαριασμών, η σύνταξη κώδικα θα χρησιμοποιήσει το EntitySetName των λογαριασμών; /_api/accounts()
Σημείωμα
Χρησιμοποιήστε το λογικό όνομα πίνακα για ρυθμίσεις τοποθεσίας (για παράδειγμα λογαριασμός).
Μπορείτε να καθορίσετε το EntitySetName συγκεκριμένων πινάκων ακολουθώντας τα παρακάτω βήματα:
Μετάβαση σε https://make.powerapps.com
Επιλέξτε την καρτέλα Dataverse από τον πλαϊνό πίνακα και επιλέξτε τον πίνακα.
Επιλέξτε ... (Επιλογή εντολών) και μετά επιλέξτε Για προχωρημένους, Εργαλεία και Αντιγραφή ονόματος συνόλου για να αντιγράψετε το EntitySetName στον πίνακα στο πρόχειρό σας.
Νόμοι και κανονισμοί προστασίας προσωπικών δεδομένων
Όλες οι κεφαλίδες αιτήματος θα έχουν ένα αναγνωριστικό επαφής που διαβιβάζεται για λόγους ελέγχου. Για έναν ανώνυμο χρήστη, αυτή η ενέργεια θα μεταβιβαστεί ως 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
Γνωστά προβλήματα
Οι χρήστες θα λάβουν ένα σφάλμα CDS εάν επικαλεστούν ένα αίτημα API ιστού GET για πίνακες που έχουν πολλαπλά επίπεδα 1 έως πολλά ή πολλά έως πολλάδικαιωμάτων πίνακα όταν τα πεδία Γονική, Επαφή ή Λογαριασμός προσθέτουν επιπλέον συνθήκες στο ερώτημα.
Για να επιλύσετε αυτό το ζήτημα, η προτεινόμενη λύση είναι να χρησιμοποιηθεί FetchXML στο ερώτημα OData.
Εναλλακτικά, ορίστε τη ρύθμιση τοποθεσίας Webapi/<table name>/disableodatafilter σε True.
Σημαντικό
Η αλλαγή της ρύθμισης τοποθεσίας Webapi/<table name>/disableodatafilter σε True μπορεί να οδηγήσει σε πιο αργές επιδόσεις για κλήσεις GET ΑΡΙ Web.
Η ρύθμιση τοποθεσίας είναι διαθέσιμη στην έκδοση πύλης 9.4.10.74 ή μεταγενέστερη έκδοση.
Επόμενο βήμα
Ερώτημα για δεδομένα χρησιμοποιώντας το Web API πυλών