Βέλτιστες πρακτικές για τη χρήση του API Microsoft Learn Catalog
Αυτό το άρθρο περιγράφει τις βέλτιστες πρακτικές για τη χρήση του API Learn Catalog.
Κατανόηση των όρων παροχής υπηρεσιών
Παρόλο που το API Learn Catalog είναι δημόσια διαθέσιμο και δωρεάν για χρήση, οι χρήστες υπόκεινται στους Όρους χρήσης του Microsoft API. Διαβάστε και κατανοήστε τους Όρους χρήσης του API πριν χρησιμοποιήσετε το API Learn Catalog και πριν συμπεριλάβετε την έξοδο σε οποιοδήποτε περιβάλλον παραγωγής.
Κατανόηση των περιορισμών του API Learn Catalog
Ανατρέξτε στο άρθρο Επισκόπηση δυνατοτήτων API Του Learn Catalog.
Κατανόηση του Learn con λειτουργία σκηνής l
Για να χρησιμοποιήσετε αποτελεσματικά την απόκριση του API Learn Catalog, είναι σημαντικό να κατανοήσετε τους τύπους περιεχομένου που είναι διαθέσιμο στο Microsoft Learn και τις σχέσεις τους μεταξύ τους. Ανατρέξτε στο άρθρο Learn con λειτουργία σκηνής l για περισσότερες πληροφορίες.
Ιδίως:
- Το UID σημαίνει Μοναδικό αναγνωριστικό και είναι μοναδικό για κάθε αντικείμενο περιεχομένου. Εάν αλλάξει ένα UID, ακόμα και αν ο τίτλος ή άλλα μετα-δεδομένα παραμείνουν τα ίδια, το περιεχόμενο θεωρείται νέο αντικείμενο.
- Οι εκπαιδευτικές ενότητες είναι το βασικό αντικείμενο στον κατάλογο εκπαίδευσης learn. Είναι όλοι ικανοί να στέκονται μόνοι τους, με την έννοια ότι διδάσκουν ένα σενάριο ή μια έννοια από άκρο σε άκρο μέσα σε αυτά και δεν απαιτούν τη λήψη προαπαιτούμενων εκπαιδευτικών ενοτήτων. Για ορισμένους, πρόκειται για αυτό και δεν αποτελούν μέρος ενός μαθησιακού διαύλου. Για άλλους, συνδυάζονται σε έναν ή περισσότερους μαθησιακούς διαύλους που καθοδηγούν έναν χρήστη στη δημιουργία πιο προηγμένων εννοιών. Μια εκπαιδευτική ενότητα δεν χρειάζεται να αποτελεί μέρος ενός μαθησιακού διαύλου ή μπορεί να αποτελεί μέρος μίας ή περισσότερων.
- Οι μονάδες δεν έχουν συνταχθεί ως αυτόνομο περιεχόμενο. Προορίζονται να ληφθούν με συγκεκριμένη σειρά για την εκπαιδευτική ενότητα. Για αυτόν τον λόγο, συμπεριλαμβάνουμε τη σύνδεση στη σελίδα λεπτομερειών της εκπαιδευτικής ενότητας και το πρώτο κεφάλαιο, έτσι ώστε οι χρήστες να μπορούν να ξεκινήσουν από εκεί και να συνεχίσουν με το περιεχόμενο.
Κατανοήστε τον τρόπο λειτουργίας της τοπικής προσαρμογής στο Learn και τον τρόπο με τον οποίο το μεταφρασμένο περιεχόμενο απεικονίζεται στην έξοδο API
Το Microsoft Learn υποστηρίζει περισσότερες από 65 τοπικές ρυθμίσεις στην τοποθεσία και μεγάλο μέρος του περιεχομένου μεταφράζεται σε αυτές τις τοπικές ρυθμίσεις. Στόχος μας είναι να καταστήσουμε το περιεχόμενο διαθέσιμο σε όλες τις γλώσσες στις οποίες τα προϊόντα που διδάσκονται στο περιεχόμενο είναι διαθέσιμα, αλλά δεν έχουν όλες οι εμπειρίες τοπικών ρυθμίσεων μεταφρασμένο περιεχόμενο.
Όταν μια εγγραφή τοπικών ρυθμίσεων δεν έχει τη σχετική μετάφραση διαθέσιμη, το περιεχόμενο στην τοποθεσία και η απόκριση του API "επιστρέφουν" στα Αγγλικά ως προεπιλογή. Στην έξοδο API, βλέπετε μετα-δεδομένα Στα Αγγλικά σε άλλες αποκρίσεις τοπικών ρυθμίσεων όταν υπάρχει επιστροφή. Ωστόσο, η διεύθυνση URL για το περιεχόμενο εξακολουθεί να δείχνει στις τοπικές ρυθμίσεις, παρόλο που το κύριο περιεχόμενο μπορεί να επανέλθει και ο λόγος είναι να επιτρέψετε στον χρήστη να εξακολουθεί να περιηγείται στην τοποθεσία σε αυτές τις τοπικές ρυθμίσεις (η οποία εμφανίζει μεταφρασμένη την κεφαλίδα/υποσέλιδα, καθώς και οποιαδήποτε άλλη σύνδεση με διαθέσιμη μετάφραση).
Όταν δημοσιεύονται ενημερώσεις στο αγγλικό περιεχόμενο, οι διοχετεύσεις τοπικής προσαρμογής λειτουργούν ώστε οι μεταφρασμένες εκδόσεις να ενημερώνονται το συντομότερο δυνατό – συνήθως μέσα σε λίγες ημέρες από την αρχική αλλαγή.
Μπορείτε να δείτε μια πλήρη λίστα των υποστηριζόμενων τοπικών ρυθμίσεων στο υποσέλιδα τοποθεσίας του Microsoft Learn (επιλέξτε τη γλώσσα που βλέπετε). Μπορείτε να χρησιμοποιήσετε το API Learn Catalog για να υποβληθούν ερωτήματα σε καθεμία από αυτές τις τοπικές ρυθμίσεις με το locale API Learn Catalog.
Οι εγγραφές ολοκλήρωσης του περιεχομένου εκπαίδευσης είναι μη αναγνωρίσιμες από τις τοπικές ρυθμίσεις, το οποίο σημαίνει ότι δεν διαφοροποιούμε τις μεταφρασμένες εκδόσεις περιεχομένου ως ξεχωριστά αντικείμενα στις εγγραφές ολοκλήρωσης εκπαίδευσης χρηστών. Ανεξάρτητα από τη γλώσσα στην οποία ολοκληρώνει μια εκπαίδευση ένας χρήστης, λαμβάνει τα εύσημα για το συνολικό αντικείμενο και δεν αποθηκεύουμε μια αναφορά σε ποια γλώσσα ολοκληρώθηκε. Αυτή η ολοκλήρωση τοπικών ρυθμίσεων σημαίνει ότι εάν υλοποιήσετε το API Learn Catalog στην εμπειρία εκμάθησής σας, πρέπει να το λάβετε υπόψη και, εάν φορτώσετε τα αντικείμενα περιεχομένου ως ξεχωριστά αντικείμενα, να εφαρμόσετε μια ισοδυναμία μεταξύ τους, έτσι ώστε, ανεξάρτητα από τη γλώσσα στην οποία ο χρήστης ολοκληρώσει την εκπαίδευση, να λάβει τα εύσημα για αυτό στις άλλες γλώσσες και να μην χρειάζεται να την επαναλάβει.
Κατανοήστε τον τρόπο λειτουργίας της διαχείρισης εκδόσεων περιεχομένου στο Learn και τον τρόπο με τον οποίο απεικονίζεται στην έξοδο API
Συγκεκριμένα, το περιεχόμενο ενημερώνεται διαρκώς. Δημοσιεύουμε διαθέσιμες ενημερώσεις δύο φορές την ημέρα. Μπορεί να είναι δευτερεύουσες, όπως μικρές αλλαγές κειμένου ή σημαντικές, όπως σημαντικές αναθεωρήσεις, προσθήκες ή διαγραφές. Σε γενικές γραμμές, η διαχείριση του χαρτοφυλακίου περιεχομένου γίνεται ως ένα τεράστιο, εξαιρετικά διαχειρισμένο έργο ανοιχτού κώδικα με χιλιάδες συνεισφέροντες και, ως εκ τούτου, αλλαγές συμβαίνουν όλη την ώρα. Εάν χρησιμοποιείτε το API Learn Catalog στο σύστημα παραγωγής σας, θα πρέπει να το γνωρίζετε και να έχετε τη δυνατότητα να το χειρίζεται το σύστημά σας.
Όταν προστίθενται νέα αντικείμενα περιεχομένου, εμφανίζονται ως νέο αντικείμενο (αναγνωρίζεται από το UID) στην απόκριση. Όταν τροποποιείται το περιεχόμενο, μπορείτε να διακριτό στοιχείο με βάση την τιμή last_modified του. Όταν διαγραφεί το περιεχόμενο, το αντικείμενο περιεχομένου καταργείται από την απόκριση. Παρόλο που μερικές φορές υπάρχει μια μικρή καθυστέρηση στην ενημέρωση του περιεχομένου στην απόκριση API, όταν ένας χρήστης ακολουθεί τη διεύθυνση URL για το περιεχόμενο, θα βλέπει πάντα τις πιο πρόσφατες πληροφορίες. Στην περίπτωση διαγραφών, η παλιά διεύθυνση URL θα ανακατευθύνει στο νέο περιεχόμενο ή την εμπειρία ή στην επόμενη καλύτερη επιλογή.
Δεν υπάρχουν αναφορές σε εκδόσεις περιεχομένου αυτήν τη στιγμή πέρα από την last_modified ημερομηνία.
Τακτική ανανέωση των δεδομένων
Εάν χρησιμοποιείτε τις πληροφορίες καταλόγου από το API Learn Catalog για να υποστηρίξετε τις επιχειρηματικές διαδικασίες σας ή που εμφανίζονται για πελάτες ως μέρος της εμπειρίας της τοποθεσίας σας, βεβαιωθείτε ότι ανανεώνετε το περιεχόμενο τουλάχιστον μία φορά την ημέρα.
Συγκεκριμένα, το περιεχόμενο ενημερώνεται διαρκώς. Δημοσιεύουμε διαθέσιμες ενημερώσεις δύο φορές την ημέρα. Μπορεί να είναι δευτερεύουσες, όπως μικρές αλλαγές κειμένου ή σημαντικές, όπως σημαντικές αναθεωρήσεις, προσθήκες ή διαγραφές. Σε γενικές γραμμές, η διαχείριση του χαρτοφυλακίου περιεχομένου γίνεται ως ένα τεράστιο, εξαιρετικά διαχειρισμένο έργο ανοιχτού κώδικα με χιλιάδες συνεισφέροντες και, ως εκ τούτου, αλλαγές συμβαίνουν όλη την ώρα. Εάν χρησιμοποιείτε το API Learn Catalog στο σύστημα παραγωγής σας, θα πρέπει να το γνωρίζετε και να έχετε τη δυνατότητα να το χειρίζεται το σύστημά σας.
Εξετάστε τις προτάσεις της τεκμηρίωσης προγραμματιστή
Η τεκμηρίωση προγραμματιστών του Learn Catalog API διαθέτει μια πλήρη λίστα με τα δεδομένα που παρέχονται ως μέρος της απάντησης, καθώς και προτάσεις σχετικά με τον τρόπο με τον οποίο συνιστάται να χρησιμοποιηθεί κάθε πεδίο για την υποστήριξη σπουδαίων εμπειριών εκμάθησης.
Κατανόηση της λογικής ερωτήματος
Υπάρχουν πολλά διαθέσιμα φίλτρα για χρήση για φιλτράρισμα εκ των προτέρων της απόκρισης, έτσι ώστε να λαμβάνετε μόνο αυτό που αναζητάτε και να μπορείτε να χειριστείτε μικρότερα μεγέθη αρχείων. Μπορείτε να δείτε την πλήρη λίστα των φίλτρων ερωτημάτων στο άρθρο Αναφορά προγραμματιστών του Learn Catalog API. Συγκεκριμένα, πρέπει να σχηματίζετε σωστά το ερώτημα και, εάν χρησιμοποιείτε περισσότερες από μία παραμέτρους ερωτήματος στην αίτηση, το ερώτημα αξιολογείται με χρήση του τελεστή AND.
Επόμενα βήματα
Για περισσότερες πληροφορίες που θα σας υποστηρίξουν με το API Learn Catalog, διαβάστε τα παρακάτω άρθρα: