Επισκόπηση
Ένα σημείο πρόσβασης, ένας φάκελος απάντησης, και οι 337 μέθοδοι στις οποίες φτάνει ένα κλειδί API.
Κάθε οθόνη του πίνακα ελέγχου Xuda, κάθε πρόγραμμα Studio και κάθε ενσωμάτωση τρίτου καλεί
την ίδια επιφάνεια HTTP: το CPI, συντομογραφία του διανομέα μεθόδων της πλατφόρμας. Υπάρχει μία μορφή
σημείου πρόσβασης, /cpi/<method>, και ένας φάκελος απάντησης. Αν τον μάθετε μία φορά, καλύπτετε και τις 337 μεθόδους στις οποίες μπορεί να φτάσει σήμερα ένα
κλειδί API λογαριασμού.
Το σημείο πρόσβασης
Το <method> είναι ένα όνομα μεθόδου όπως get_account_projects ή dbs_read, ποτέ μια διαδρομή πόρου
με αναγνωριστικό μέσα της. Κάθε είσοδος, συμπεριλαμβανομένου ενός αναγνωριστικού, είναι παράμετρος: στο POST είναι πεδίο σε ένα σώμα
JSON, στο GET είναι παράμετρος της συμβολοσειράς ερωτήματος (δείτε την Κλήση μιας μεθόδου για
τους κανόνες σώματος έναντι ερωτήματος και παραδείγματα σε cURL, JavaScript και Python).
Η τεκμηρίωση εξυπηρετείται στο xuda.ai/docs, οπότε το sandbox σε αυτόν τον ιστότοπο καλεί το /cpi/<method>
στην ίδια προέλευση. Ο δικός σας κώδικας, που τρέχει οπουδήποτε, καλεί απευθείας το https://xuda.ai/cpi/<method>.
Ο φάκελος απάντησης
Κάθε μέθοδος, με επιτυχία ή αποτυχία, απαντά με την ίδια μορφή:
- Το
code > 0είναι επιτυχία. Ο ίδιος ο αριθμός δεν έχει άλλη σημασία πέρα από το ότι είναι θετικός, διαβάστε τοdata. - Το
code < 0είναι σφάλμα. Τοdataείναι συνήθως ένα μήνυμα κειμένου. μια αποτυχία επικύρωσης προσθέτει επίσης ένα πεδίοmessageπου προκύπτει από αυτό. Δείτε τα Σφάλματα για τους κωδικούς που αξίζει να διακλαδώσετε και για εκείνους που πρέπει απλώς να καταγράψετε και να εμφανίσετε. - Μια μέθοδος που επιστρέφει αρχείο ή προσαρμοσμένο τύπο περιεχομένου (μια εξαγωγή CSV, μια εικόνα) παραλείπει τον φάκελο JSON και ορίζει δικές της κεφαλίδες και σώμα. Αυτό είναι η εξαίρεση, όχι ο κανόνας.
- Μια επιτυχής απάντηση φέρει μια κεφαλίδα
xu-regionπου ονομάζει την περιοχή Xuda που χειρίστηκε την κλήση. Μια απάντηση σφάλματος δεν τη φέρει.
Εξουσιοδότηση και το ιδιωτικό τείχος
Κάθε μέθοδος φέρει ένα clearance: public, user, user_access, developer ή admin. Αυτό
είναι ποιος μπορεί να τη φτάσει μέσω συνδεδεμένης συνεδρίας πίνακα ελέγχου: μια μέθοδος public δεν χρειάζεται τίποτα,
οι υπόλοιπες χρειάζονται συνεδρία σε αυτό το επίπεδο ή υψηλότερο.
Ένα κλειδί API είναι ξεχωριστό τείχος, όχι ένα ακόμη επίπεδο εξουσιοδότησης. Μια μέθοδος φέρει επίσης μια σημαία private.
Το private: true είναι απόλυτο: κανένα κλειδί API δεν μπορεί να την καλέσει, ούτε καν ένα με πλήρη πρόσβαση, ανεξάρτητα από
το clearance της. Περίπου το ένα τέταρτο του καταλόγου είναι δημόσιο με αυτή την έννοια: 337 μέθοδοι σε 24
microservices, που εκτείνονται από το Voice και τα Domains μέχρι το Drive και το API συγγραφής του Studio.
Οι υπόλοιπες, συμπεριλαμβανομένης κάθε μεθόδου στο ίδιο το api_module (οι μέθοδοι που δημιουργούν και διαχειρίζονται κλειδιά
API), παραμένουν μόνο για συνεδρίες. Η Ταυτοποίηση καλύπτει την πλήρη έναντι της προσαρμοσμένης πρόσβασης
κλειδιού, και κάθε οδηγός ενότητας παρακάτω τελειώνει με τον ζωντανό πίνακα του τι εκθέτει το microservice του.
Εύρεση μιας μεθόδου
Η διαδραστική αναφορά API απαριθμεί και τις 337 μεθόδους με τα πεδία τους, και σας επιτρέπει να εκτελέσετε μία στον δικό σας λογαριασμό απευθείας από το πρόγραμμα περιήγησης.