Παρουσιάζοντας την πύλη API Developer Portal της Imagine
Καθώς οι επιλογές για την κατανάλωση περιεχομένου συνεχίζουν να αυξάνονται, είναι δύσκολο να προβλέψετε πού θα βλέπουν τηλεόραση οι θεατές σας ή πώς να αξιοποιήσετε καλύτερα αυτό το κοινό. Για να συμβαδίζετε με το ρυθμό αυτό, απαιτούνται ευέλικτες, ανθεκτικές στο μέλλον λύσεις που μπορείτε να προσαρμόσετε για το σήμερα, με την προσδοκία ότι οι αυριανές επιχειρηματικές ανάγκες θα αλλάξουν.
Στη Imagine, πιστεύουμε ότι το κλειδί για ένα ακμαίο μέλλον είναι να ενεργοποιήσουμε ανοιχτά, εύχρηστα μοντέλα ολοκλήρωσης, ώστε να μπορούμε όλοι να προχωρήσουμε πιο γρήγορα. Αυτή η πεποίθηση ήταν η κινητήρια δύναμη πίσω από μια σημαντική, εταιρική πρωτοβουλία που ξεκινήσαμε τον Απρίλιο του 2022 για τη δημιουργία μιας πύλης API Developer Portal.
Το έργο Imagine’s API Developer Portal έθεσε ως στόχο την επίτευξη δύο αρχικών στόχων:
- Να επεκτείνουμε τη φιλοσοφία της ανοικτής μας πλατφόρμας παρέχοντας στους πελάτες μας πρόσβαση στα API μας, ώστε να είναι ευκολότερη η ενσωμάτωση με τα προϊόντα μας.
2. Δημιουργία ενός εργαλείου που επιτρέπει στους συνεργάτες και τους υποψήφιους πελάτες να δουν πώς τα προϊόντα Imagine συμβάλλουν στην προώθηση της καινοτομίας σε ένα διαρκώς μεταβαλλόμενο επιχειρηματικό περιβάλλον.
Εδώ σας δίνουμε μια εσωτερική άποψη σχετικά με το τι χρειάστηκε για την κατασκευή της πύλης, την τρέχουσα κατάσταση του έργου και πώς μπορείτε να αποκτήσετε πρόσβαση σε ένα αποθετήριο συνεχώς ενημερωμένων και πλήρως τεκμηριωμένων API που επιτρέπουν την ταχεία ενσωμάτωση μεταξύ των υφιστάμενων εργαλείων σας και των λύσεων της Imagine.
Συλλογή των δεδομένων μας
Η ομάδα έργου, η οποία αποτελείται από ενδιαφερόμενους από την Ε&Α, τη διαχείριση προϊόντων, την αρχιτεκτονική και την τεκμηρίωση προϊόντων, ξεκίνησε συζητώντας το αρχικό πεδίο εφαρμογής του έργου, εξετάζοντας άλλες πύλες API και τεκμηρίωση, αξιολογώντας επιλογές εργαλείων και συλλέγοντας τα API μας.
Πιθανότατα δεν αποτελεί έκπληξη το γεγονός ότι με δεκάδες προϊόντα υλικού και λογισμικού στο χαρτοφυλάκιο της Imagine και με διασκορπισμένες σε παγκόσμιο επίπεδο ομάδες Ε&Α και προϊόντων, διαπιστώσαμε γρήγορα ότι η υπάρχουσα τεκμηρίωση API και πρωτοκόλλων είχε δημιουργηθεί και συντηρηθεί με διάφορους τρόπους κατά τη διάρκεια των ετών:
Σχεδιάστηκε με τη χρήση διαφόρων μεθόδων (REST, SOAP, XML, Java κ.λπ.)
Ταξινόμηση ανάλογα με το κοινό σε εσωτερικά API, εξωτερικά API και ορισμένα με εσωτερικά και εξωτερικά σημεία τερματισμού
Δημοσιεύθηκαν ως οδηγοί PDF που γρήγορα παρήκμασαν
Αποθηκεύτηκαν διακριτικά σε μεμονωμένους σκληρούς δίσκους Ε&Α, όπου η διάδοσή τους θα μπορούσε να ρυθμιστεί.
Γράφτηκαν με διαφορετικά επίπεδα πληρότητας, τεκμηρίωσης και δειγμάτων κώδικα
Ενοποίηση της προσέγγισής μας στην ανάπτυξη API
Η εξέταση της ιστορικά διαφορετικής κατάστασης των API μας δημιούργησε την επόμενη σειρά στόχων για την Πύλη προγραμματιστών API:
Δημιουργία ενός εταιρικού προτύπου για την ανάπτυξη και την τεκμηρίωση νέων API.
Τα API μας συνδέουν τα προϊόντα της Imagine μεταξύ τους και με τα προϊόντα των συνεργατών και των πελατών μας, οπότε η συνέπειά τους είναι κρίσιμη για την εύκολη εφαρμογή τους. Αρχικά, συζητήσαμε το ενδεχόμενο να ξαναγράψουμε όλα τα API μας ως REST, αλλά αυτό δεν ήταν πρακτικό από τεχνική άποψη ή από άποψη πόρων – περισσότερα σε αυτό σε λίγο. Προχωρώντας προς τα εμπρός, όλα τα νέα API είναι REST, βασισμένα στο πρότυπο OpenAPI της Swagger.
Αποθήκευση όλων των API για τα τρέχοντα, παλαιά και μελλοντικά προϊόντα
Η απόφαση της ομάδας να επικεντρωθεί στον σχεδιασμό REST σήμαινε ότι ορισμένα από τα παλαιότερα API και πρωτόκολλά μας δεν θα “χωρούσαν” στο εργαλείο που βασίζεται στο REST και επιλέξαμε για την Πύλη μας. Για να λύσουμε αυτό το πρόβλημα και να εστιάσουμε τους πόρους μας στα νεότερα API, ο αρχιτέκτονας μας δημιούργησε μια διαδικασία για την προσθήκη ενός συνδέσμου προς τους παλαιότερους οδηγούς API σε μορφή PDF στην Πύλη – τους αποκαλούμε “API μεσολάβησης” επειδή δεν περιέχουν κώδικα. Όταν ένας ενημερωμένος οδηγός είναι έτοιμος, μπορούμε να αντικαταστήσουμε τον παλιό γρήγορα και οι πελάτες μας μπορούν να έχουν άμεση πρόσβαση σε αυτούς στην Πύλη.
Αυτοματοποιήστε (όσο το δυνατόν περισσότερο) τη ροή εργασιών της πύλης
Ο στόχος εδώ ήταν να μειωθεί η χρονική δέσμευση της Έρευνας και Ανάπτυξης για την τοποθέτηση νέων και ενημερωμένων API στην Πύλη. Τα API μας είναι πλέον τεκμηριωμένα μέσα στον κώδικά τους, αλλά αυτό αυξάνει την επιβάρυνση των προγραμματιστών που γνωρίζουν τι κάνουν τα σημεία ενσωμάτωσης. Για να οργανώσουμε την ανάπτυξη API σε διαχειρίσιμα κομμάτια, ενσωματώσαμε αυτή την εργασία στο SAFe Agile PI Planning και την παρακολουθούμε με εισιτήρια Jira.
Ανακαλύψτε τα προϊόντα της Imagine-A έως X
Μετά από ενάμιση χρόνο εργασίας, έχουμε τώρα 36 API και πληρεξούσια ολοκληρωμένα στην Πύλη API Developer Portal και λιγότερα από οκτώ που απομένουν να προσθέσουμε – εκτός αν βρούμε επιπλέον που κρύβονται κάπου! Αυτά τα API είναι συνολικά περισσότερα από 1.600 σημεία ενσωμάτωσης σε όλα τα νεότερα και παλαιότερα προϊόντα μας – προϊόντα από το “Α έως το Χ” (αλλά όχι το “Ζ” ακόμα). Αν δεν βλέπετε ένα από τα προϊόντα σας να αναφέρεται εδώ, το API του είναι πιθανότατα σε εξέλιξη.
Εσωτερικά, η ροή εργασιών της πύλης έχει αρχίσει να ενσωματώνεται στις διαδικασίες των ομάδων μας και τα ενημερωμένα API εμφανίζονται πλέον παράλληλα με τις κυκλοφορίες προϊόντων. Η ομάδα έργου μας συνεδριάζει εβδομαδιαία για να καταγράφει την τρέχουσα εργασία, να επιλύει προβλήματα και να συζητά τα επόμενα βήματα για τη βελτίωση του περιεχομένου της Πύλης. Οι ομάδες πωλήσεων και υπηρεσιών μπορούν να παρουσιάσουν την Πύλη API Developer Portal σε πιθανούς πελάτες και να γνωρίζουν ότι περιέχει τις πιο πρόσφατες πληροφορίες.
Για τους συνεργάτες και τους πελάτες μας που συνεργάζονται με το Imagine, η δυνατότητα επισκόπησης των API σε συνδυασμό με άλλες πληροφορίες για το προϊόν ενισχύει τη διαδικασία ανακάλυψης. Οι πελάτες που έχουν ήδη εφαρμόσει τα API μας, μας δίνουν ανατροφοδότηση – τόσο για τα καλά όσο και για τα κακά – η οποία βοηθά στον καθορισμό βελτιώσεων στα API και στον σχεδιασμό μελλοντικών χαρακτηριστικών του προϊόντος. Αυτός ο διάλογος μας επιτρέπει να ανταποκρινόμαστε ταχύτερα στις ανάγκες της επιχείρησής σας.
Τι μπορεί να κάνει η πύλη API Developer Portal της Imagine για εσάς;
Αν είστε νέοι στις σειρές προϊόντων της Imagine, ρωτήστε αν υπάρχει API για το προϊόν. Συμβουλή: Ορισμένα προϊόντα διαθέτουν πολλαπλά API! Μπορούμε να σας δείξουμε τι είναι διαθέσιμο στην Πύλη προγραμματιστών API, ώστε να μάθετε πώς να αξιοποιείτε τα χαρακτηριστικά ενός προϊόντος, για να βελτιώσετε την ταχύτητα ολοκλήρωσης και το τελικό σας αποτέλεσμα.
Εάν έχετε ήδη προϊόντα της Imagine, η Πύλη API Developer Portal σας επιτρέπει να έχετε εύκολη πρόσβαση στις πιο ενημερωμένες εκδόσεις των API μας και της τεκμηρίωσής τους, ώστε να μπορείτε να επωφεληθείτε από τις τελευταίες αλλαγές στην ανοικτή πλατφόρμα μας. Καθώς ο κλάδος παρουσιάζει νέες επιχειρηματικές προκλήσεις, μπορείτε να προσαρμόσετε την απάντησή σας γρήγορα χρησιμοποιώντας λιγότερους πόρους και μεγιστοποιώντας τα έσοδά σας.
Το πιο σημαντικό είναι ότι η πύλη API Developer Portal είναι ένας ακόμη τρόπος με τον οποίο η Imagine εργάζεται για να βοηθήσει τον κλάδο να ξεπεράσει τις τρέχουσες επιχειρηματικές προκλήσεις και να συμβαδίσει με τις αλλαγές που μετασχηματίζουν τις σύγχρονες επιχειρήσεις.