Δημιουργία προσαρμοσμένου API στο Power Apps

Όταν δημιουργείτε ένα προσαρμοσμένο API, πρέπει να χρησιμοποιήσετε μια λύση. Εάν δεν είστε εξοικειωμένοι με τις λύσεις, διαβάστε πρώτα το θέμα Δημιουργία λύσης.

Η λύση σας πρέπει να συσχετίζεται με έναν εκδότη. Ο εκδότης έχει ένα συγκεκριμένο πρόθεμα προσαρμογής που σχετίζεται με αυτό. Πρέπει να χρησιμοποιήσετε ένα πρόθημα προσαρμογής κατά τη δημιουργία ενός προσαρμοσμένου API και αυτό το πρόθεμα θα πρέπει να είναι το ίδιο που χρησιμοποιείται από τον εκδότη της λύσης σας. Οι ακόλουθες οδηγίες χρησιμοποιούν την τιμή sample ως πρόθημα προσαρμογής, επειδή είναι αυτό που έχει οριστεί για τον εκδότη.

Σημαντικό

• Υπάρχει τώρα μια καλύτερη εμπειρία για τη δημιουργία προσαρμοσμένου API. Μπορείτε να χρησιμοποιήσετε ένα εργαλείο σχεδίασης στο εργαλείο καταχώρησης προσθηκών. Περισσότερες πληροφορίες: Δημιουργία προσαρμοσμένου API με χρήση του εργαλείου καταχώρησης προσθηκών
• Πολλά πεδία που σχετίζονται με τη δημιουργία προσαρμοσμένου API δεν μπορούν να αλλάξουν μετά τη δημιουργία τους. Πριν ξεκινήσετε, θα πρέπει να σχεδιάσετε προσεκτικά τη σχεδίαση του προσαρμοσμένου API. Εάν αποφασίσετε αργότερα ότι χρειάζεται να αλλάξετε στοιχεία αφού δημιουργήσετε το προσαρμοσμένο API, ίσως χρειαστεί να διαγράψετε την υπάρχουσα εγγραφή και να δημιουργήσετε εκ νέου το προσαρμοσμένο API. Εξετάστε τις πληροφορίες σχετικά με τις στήλες που δεν μπορούν να αλλάξουν εδώ: Πίνακες CustomAPI

Δημιουργία προσαρμοσμένης εγγραφής API

1. Στη λύση σας, επιλέξτε Νέο>περισσότερα>άλλα>προσαρμοσμένα API από την αναπτυσσόμενη λίστα.

2. Επεξεργαστείτε τα πεδία για να ορίσετε τις ιδιότητες του προσαρμοσμένου API σας. Πρέπει να ορίσετε τιμές για τα παρακάτω πεδία. Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα Προσαρμοσμένες στήλες πίνακα API

   Δεν μπορείτε να ορίσετε τιμές για Τύπο προσθήκης πριν από τη δημιουργία της προσθήκης. Μπορείτε να το αλλάξετε αργότερα.

3. Επιλέξτε Αποθήκευση. Η φόρμα σας θα πρέπει να μοιάζει κάπως έτσι:

Δημιουργία οποιωνδήποτε παραμέτρων αίτησης

Ένα προσαρμοσμένο API δεν απαιτεί παραμέτρους. Δημιουργήστε όσες παραμέτρους χρειάζεστε για να διαβιβάσετε τα δεδομένα που απαιτούνται για τη λογική σας.

1. Στη λύση σας, επιλέξτε Νέα>περισσότερες>άλλες>προσαρμοσμένες παραμέτρους αίτησης API από την αναπτυσσόμενη λίστα.

2. Επεξεργαστείτε τα πεδία για να ορίσετε τις ιδιότητες της προσαρμοσμένης παραμέτρου αίτησης API. Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα CustomAPIRequestParameter Table Columns

3. Επιλέξτε Αποθήκευση. Η φόρμα σας θα πρέπει να μοιάζει κάπως έτσι:

   

Δημιουργία οποιωνδήποτε ιδιοτήτων απόκρισης

Ένα προσαρμοσμένο API που αντιπροσωπεύει μια ενέργεια δεν απαιτεί ιδιότητες απόκρισης. Μια συνάρτηση πρέπει να έχει τουλάχιστον μία. Εάν η λειτουργία είναι επιτυχής, επιστρέφει μια απόκριση επιτυχίας. Εάν αποτύχει, επιστρέφει ένα σφάλμα. Θα πρέπει να ορίσετε ιδιότητες απόκρισης για οποιαδήποτε δεδομένα επιστρέφει το API σας.

Εάν έχει οριστεί μόνο μία ιδιότητα απόκρισης Οντότητα ή EntityCollection , η απόκριση είναι αυτού του τύπου. Εάν υπάρχουν πολλές ιδιότητες ή μία ή περισσότερες ιδιότητες ενός απλού τύπου, το API επιστρέφει έναν σύνθετο τύπο όπου κάθε ιδιότητα απόκρισης είναι μια ιδιότητα αυτού του σύνθετου τύπου.

Για παράδειγμα, εάν το προσαρμοσμένο σας μοναδικό όνομα API είναι sample_CustomAPIExample, επιστρέφει έναν σύνθετο τύπο με την ονομασία sample_CustomAPIExampleResponse με ιδιότητες για κάθε ιδιότητα απόκρισης που ορίζετε.

1. Στη λύση σας, επιλέξτε Νέα>περισσότερες>άλλες>προσαρμοσμένες ιδιότητα απόκρισης API από την αναπτυσσόμενη λίστα.

2. Επεξεργαστείτε τα πεδία για να ορίσετε τις ιδιότητες της προσαρμοσμένης σας ιδιότητας απόκρισης API. Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα CustomAPIResponseProperty Table Columns

3. Επιλέξτε Αποθήκευση. Η φόρμα σας θα πρέπει να μοιάζει κάπως έτσι:

   

Παρατηρήστε το αποτέλεσμα στο έγγραφο υπηρεσίας

Εάν δεν έχετε ορίσει την ιδιότητα για το IsPrivate προσαρμοσμένο API σας, μπορείτε πλέον να ανακτήσετε τον ορισμό υπηρεσίας από το έγγραφο CSDL $metadata χρησιμοποιώντας μια GET αίτηση, ακόμα και από το πρόγραμμα περιήγησής σας. Εάν η διεύθυνση URL για το περιβάλλον σας είναι https://yourorg.crm.dynamics.com, μπορείτε να πληκτρολογήσετε αυτήν τη διεύθυνση URL στο πεδίο διεύθυνσης του προγράμματος περιήγησης για να ανακτήσετε το $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Κάντε αναζήτηση στο αποτέλεσμα για να βρείτε το όνομα του προσαρμοσμένου API. Για παράδειγμα, το API που έχει οριστεί με χρήση των παραπάνω βημάτων μοιάζει κάπως έτσι:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

Δοκιμή του προσαρμοσμένου API σας

Αφού δημιουργήσετε το προσαρμοσμένο API, μπορείτε να το δοκιμάσετε. Ακόμα και αν δεν έχετε ορίσει έναν τύπο προσθήκης για να ορίσετε την κύρια λειτουργία, μπορείτε να την δοκιμάσετε τώρα για να επαληθεύσετε ότι μπορείτε να την καλέσετε σωστά. Οποιεσδήποτε ιδιότητες απόκρισης επιστρέφουν την προεπιλεγμένη τιμή τους, όπως null. Περισσότερες πληροφορίες: Κλήση προσαρμοσμένων API.

Ενημέρωση του προσαρμοσμένου τύπου προσθήκης API

Για πληροφορίες σχετικά με τον τρόπο εγγραφής μιας προσθήκης για ένα προσαρμοσμένο API, ανατρέξτε στο θέμα Εγγραφή προσθήκης για το προσαρμοσμένο API σας.

Αφού καταχωρήσετε τη συγκρότησή σας, πρέπει να ορίσετε την τιμή Τύπος προσθήκης για το προσαρμοσμένο API που δημιουργήσατε. Αυτή είναι μια ιδιότητα αναζήτησης, επομένως χρειάζεται απλώς να βρείτε τον τύπο προσθήκης που αντιπροσωπεύει τον τύπο που δημιουργήθηκε κατά την καταχώρηση της συγκρότησης.

Αφού ορίσετε τον τύπο προσθήκης, μπορείτε να δοκιμάσετε το προσαρμοσμένο API για να επαληθεύσετε ότι επιστρέφονται τα σωστά αποτελέσματα.

Άλλοι τρόποι για να δημιουργήσετε προσαρμοσμένα API

Το εργαλείο καταχώρησης προσθήκης παρέχει ένα προσαρμοσμένο εργαλείο σχεδίασης API. Περισσότερες πληροφορίες: Δημιουργία προσαρμοσμένου API με χρήση του εργαλείου καταχώρησης προσθηκών

Μπορεί να έχετε απαιτήσεις για τη δημιουργία μιας εφαρμογής-πελάτη που επιτρέπει τη δημιουργία προσαρμοσμένων API εκτός του προγράμματος σχεδίασης. Επειδή τα δεδομένα για τα προσαρμοσμένα API αποθηκεύονται σε πίνακες, μπορείτε να τα δημιουργήσετε χρησιμοποιώντας κώδικα. Περισσότερες πληροφορίες: Δημιουργήστε ένα προσαρμοσμένο API με κώδικα.

Η διαδικασία ALM μπορεί να εξυπηρετηθεί καλύτερα με τη δημιουργία προσαρμοσμένων API με την επεξεργασία αρχείων λύσης. Περισσότερες πληροφορίες: Δημιουργήστε ένα προσαρμοσμένο API με αρχεία λύσης.

Δείτε επίσης

Δημιουργία και χρήση προσαρμοσμένων API
Δημιουργία προσαρμοσμένου API με χρήση του εργαλείου καταχώρησης προσθηκών
Δημιουργία προσαρμοσμένου API με κώδικα
Δημιουργία προσαρμοσμένου API με αρχεία λύσης
Δημιουργία των δικών σας μηνυμάτων