Προαιρετικό API έργου
Εμφανίστε τις συμφωνημένες λειτουργίες της εφαρμογής όταν τις χρειάζεστε
Ελέγξτε το εύρος ενός API για ένα επιλέξιμο έργο και διακρίνετε τις προγραμματισμένες διαδρομές από τα ήδη υπάρχοντα endpoints.
Αντιμετωπίστε το API ως μια καθορισμένη επιλογή έργου
- Ελέγξτε την επιλογή
Ελέγξτε τη διαθεσιμότητα του API και την αντίστοιχη προσφορά έργου.
- Ορίστε το εύρος της διαδρομής
Διευκρινίστε τις επιχειρησιακές λειτουργίες που θα πρέπει να παρέχει το API.
- Ελέγξτε τον κατάλογο διαδρομών
Ελέγξτε τη μέθοδο, τη διαδρομή και την προγραμματισμένη ή την τρέχουσα κατάσταση κάθε διαδρομής.
Προσθέστε ένα API όταν το απαιτεί το έργο σας
Το API του έργου είναι ένα προαιρετικό μέρος της προσφοράς. Ελέγξτε το εύρος και τους όρους του πριν από την ενεργοποίησή του, αντί να υποθέτετε ότι κάθε εφαρμογή το περιλαμβάνει.
Τα εργαλεία API οργανώνουν τις προτεινόμενες διαδρομές ανά επιχειρηματική περιοχή. Οι διευκρινίσεις βοηθούν στον καθορισμό του τι πρέπει να κάνει κάθε λειτουργία πριν από την υλοποίησή της.
Διακρίνετε τις προοριζόμενες διαδρομές από τα ενεργά σημεία τερματισμού
Δημιουργήστε πρόσβαση για ένα άλλο σύστημα. Ένα έργο ενδέχεται να χρειάζεται μια άλλη εφαρμογή για να χρησιμοποιήσει τις επιχειρηματικές του λειτουργίες. Ελέγξτε την προαιρετική εμβέλεια του API και την προσφορά, αντί να υποθέτετε ότι κάθε λειτουργία είναι αυτόματα διαθέσιμη. Οι συμφωνημένες λειτουργίες καθορίζουν σε τι θα πρέπει να έχει πρόσβαση η ενσωμάτωση.
Ελέγξτε τον κατάλογο διαδρομών. Ο κατάλογος παρουσιάζει τη μέθοδο, τη διαδρομή, την περιγραφή και την κατάσταση κάθε διαδρομής. Βοηθά στην διάκριση της προτεινόμενης εμβέλειας από τα τελικά σημεία που έχουν καταχωρηθεί ως ενεργά. Αυτό αποτελεί μια πρακτική αναφορά κατά την παρακολούθηση της προετοιμασίας του API.
Επιλέξτε την σωστή κατεύθυνση ενσωμάτωσης. Η χρήση του API ενός άλλου παρόχου και η προβολή της δικής σας εφαρμογής είναι διαφορετικές ανάγκες. Οι εξωτερικές συνδέσεις καλύπτουν την πρώτη περίπτωση. Το API του έργου καλύπτει την συμφωνημένη προβολή. Επιλέξτε τη διαδρομή που ταιριάζει με την επιχειρηματική ανταλλαγή που επιθυμείτε.
Διακρίνετε ένα εκτεθειμένο API από μια εξωτερική σύνδεση
Ένα API έργου παρουσιάζει τις συμφωνημένες λειτουργίες της εφαρμογής σας. Μια εξωτερική σύνδεση περιγράφει πώς η εφαρμογή σας χρησιμοποιεί μια άλλη υπηρεσία· εξυπηρετούν διαφορετικές ανάγκες.
Χρησιμοποιήστε τον κατάλογο διαδρομών για να ελέγξετε τη μέθοδο, τη διαδρομή και εάν ένα σημείο τερματισμού είναι προγραμματισμένο ή ενεργό. Αυτή η παρουσίαση δεν ενεργοποιεί ένα API για το έργο σας.
Αξιολογήστε την επιλογή API με βάση μια συγκεκριμένη ανάγκη
Προσδιορίστε ποιος θα χρησιμοποιεί τα δεδομένα του έργου και ποιες λειτουργίες απαιτεί αυτή η ενοποίηση. Αυτό βοηθά να διακριθεί ένα προαιρετικό εύρος API από μια σύνδεση με μια υπάρχουσα εξωτερική υπηρεσία.
Για ένα επιλέξιμο έργο, εξετάστε τις προγραμματισμένες διαδρομές και την κατάσταση κατασκευής τους. Επιβεβαιώστε τη σχετική υπηρεσία και το περιβάλλον πριν θεωρήσετε ένα τελικό σημείο διαθέσιμο για ενοποίηση.
Από ένα προαιρετικό εύρος σε επαληθευμένη προβολή
Ελέγξτε τη διαθεσιμότητα και τους όρους. Ελέγξτε την επιλογή API στην τρέχουσα προσφορά του έργου. Αποφασίστε εάν η εφαρμογή χρειάζεται αυτή την έκθεση πριν από την ενεργοποίηση.
Επεξηγήστε τις λειτουργίες. Ελέγξτε τις προτεινόμενες επιχειρησιακές λειτουργίες και απαντήστε σε ερωτήσεις σχετικά με την αναμενόμενη συμπεριφορά τους. Ακολουθήστε τις φάσεις προετοιμασίας και κατασκευής.
Δείτε τι είναι διαθέσιμο. Ελέγξτε τον κατάλογο διαδρομών και την δημοσιευμένη αναφορά για ένα ενεργοποιημένο έργο. Μια προγραμματισμένη διαδρομή δεν είναι ένα λειτουργικό σημείο εκκίνησης.
Ορίστε το εύρος της ενσωμάτωσης πριν προσθέσετε ένα API
Εξηγήστε τις λειτουργίες που απαιτεί ένα άλλο σύστημα και εξετάστε τις συνθήκες της επιλογής. Το API θα πρέπει να υποστηρίζει μια συμφωνημένη επιχειρηματική ανταλλαγή.
Ερωτήσεις σχετικά με το API του προαιρετικού έργου
Είναι μια επιλογή, η διαθεσιμότητα και η τιμή της εμφανίζονται στην πραγματική προσφορά. Μια εφαρμογή μπορεί να λειτουργήσει χωρίς να την ενεργοποιεί. Αυτή η παρουσίαση δεν παρέχει ούτε ενεργοποιεί ένα API για το έργο σας.
Περιγράφει μια προγραμματισμένη λειτουργία που δεν έχει ακόμη καταχωρηθεί ως ενεργό σημείο πρόσβασης. Χρησιμοποιήστε την κατάσταση του καταλόγου και την πραγματική δημοσιευμένη αναφορά πριν ξεκινήσετε την ενσωμάτωση.
Οι προβολές API του έργου δείχνουν τις περιοχές που θα εμφανιστούν, τις ερωτήσεις, τις υποδομές και τις καταστάσεις κατασκευής. Επιλύστε τις δηλωμένες προϋποθέσεις και ελέγξτε τον προκύπτοντα κατάλογο διαδρομών.
Χρησιμοποιήστε την τεκμηρίωση του API που ανήκει στο ενεργοποιημένο έργο και στο σχετικό περιβάλλον. Μην αντλείτε ένα σημείο τερματισμού ή ένα παράδειγμα ελέγχου ταυτότητας μόνο από μια προγραμματισμένη διαδρομή.
Περιγράφουν μια άλλη υπηρεσία που χρησιμοποιεί η εφαρμογή σας. Αυτή η κατεύθυνση ενσωμάτωσης είναι διαφορετική από την έκθεση των δικών σας λειτουργιών εφαρμογής μέσω του API του έργου.