Ο τρόπος με τον οποίο σχεδιάζετε το προϊόν API σας μπορεί να κάνει τη διαφορά μεταξύ ενός νικητήριου προϊόντος που απογειώνεται γρήγορα και ενός προϊόντος που δεν φαίνεται πραγματικά να βγαίνει από το έδαφος. Εάν θέλετε το API σας να είναι εύκολα ανιχνεύσιμο και υιοθετήσιμο, ακολουθήστε τα παρακάτω απλά βήματα για την παραγωγή API.
Ο εξαιρετικός σχεδιασμός προϊόντων API ξεκινά με εξαιρετική μοντελοποίηση API
Η δημιουργία ενός προϊόντος API που είναι αναλώσιμο, αποδοτικό και ικανοποιεί μια ανάγκη σημαίνει ότι ξεκινά με τον καθορισμό των στόχων του και των περιπτώσεων χρήσης. Αυτό Διαδικασία μοντελοποίησης API απαιτεί ξεκάθαρη κατανόηση του κοινού-στόχου σας, συμπεριλαμβανομένων των αναγκών και των σημείων πόνου, οπότε ήρθε η ώρα να κάνετε κάποια έρευνα. Σιγουρέψου ότι οικοδομήσουμε μια σταθερή επιχειρηματική υπόθεση για το προϊόν API σας και αποκτήστε αρχική αγορά από τα ενδιαφερόμενα μέρη σας.
Από αυτήν την άποψη, να θυμάστε ότι ένα προϊόν API δεν διαφέρει από οποιοδήποτε άλλο προϊόν. Πριν ξεκινήσετε τη φάση ανάπτυξης, θα πρέπει να βεβαιωθείτε ότι ο σχεδιασμός του προϊόντος ανταποκρίνεται σε μια ανάγκη, ότι γνωρίζετε σε ποιον το στοχεύετε και ότι η λύση που σχεδιάζετε είναι εφικτή και οικονομικά προσιτή.
Βασικές αρχές σχεδιασμού API
Οι αποφάσεις που λαμβάνετε στο στάδιο του σχεδιασμού API μπορούν να έχουν σημαντικό αντίκτυπο στο πόσο καλά καταλήγει να λαμβάνεται το προϊόν API σας. Εάν σχεδιάζετε το API σας με κακή χρήση ή η πύλη προγραμματιστή σας παρέχει ανεπαρκή εργαλεία αυτοεξυπηρέτησης για πρόσβαση στα API και εντοπισμό σφαλμάτων στη ροή ενοποίησης ή η τεκμηρίωσή σας προκαλεί σύγχυση ή το κιτ ανάπτυξης λογισμικού (SDK) είναι άβολο, οι προγραμματιστές θα δυσκολευτούν να υιοθετήσουν το προϊόν σας .
Αυτό σημαίνει ότι οι ενσωματώσεις διαρκούν περισσότερο και κοστίζουν περισσότερο, με αποτέλεσμα χαμηλό ποσοστό υιοθέτησης ή υψηλό ποσοστό εκτροπής. Ή ενδεχομένως και τα δύο. Ως εκ τούτου, είναι απαραίτητο να δίνετε προτεραιότητα σε θέματα όπως η ροή πρόσβασης και τα αναλυτικά στοιχεία σας από την αρχή.
Η κατανόηση της φύσης της επιχειρηματικής διαδικασίας με την οποία θα αλληλεπιδράσει το API σας είναι ζωτικής σημασίας εδώ. Αυτό θα υπαγορεύσει τον τρόπο με τον οποίο θα εφαρμόσετε το προϊόν API σας, επιτρέποντάς σας να το συνυπολογίσετε στη σχεδίαση. Για παράδειγμα, εάν η διαδικασία ολοκλήρωσης είναι ασύγχρονη από τη φύση της, όπως συμβαίνει με τις υπηρεσίες παράδοσης ή το λογισμικό HR, τότε θα πρέπει να εξετάσετε το ενδεχόμενο εφαρμογής webhook για τα ασύγχρονα μέρη της.
Οι αποφάσεις σχεδιασμού θα ποικίλλουν ανάλογα με τις ανάγκες των πελατών σας, γι‘ αυτό η κατανόηση των σημείων και των στόχων του πόνου των πελατών είναι τόσο θεμελιώδης για τη διαδικασία μοντελοποίησης API που προηγείται της φάσης σχεδιασμού. Οι πελάτες σας, για παράδειγμα, θέλουν να ενσωματώσουν την υπηρεσία σας στην παρουσία τους στο Salesforce για να αυτοματοποιήσουν τις μη αυτόματες εργασίες επιρρεπείς σε σφάλματα και να εξοικονομήσουν χρόνο για τους υπαλλήλους τους; Ή μήπως εισάγουν μια νέα δυνατότητα στην εφαρμογή τους για κινητά για να αυξήσουν την αφοσίωση των πελατών;
Όλα αυτά συμβάλλουν στις αποφάσεις σχεδιασμού σας: όλες οι πτυχές του προϊόντος σας API θα πρέπει να το λάβουν υπόψη, από τον έλεγχο ταυτότητας έως τα SDK και τις εγκαταστάσεις αυτοεξυπηρέτησης. Όποιες και αν είναι οι προτεραιότητες των πελατών σας, το να σχεδιάζετε καλά έχοντας αυτές κατά νου θα είναι καλό για το ενδεχόμενο ποσοστό υιοθεσίας σας.
Σχεδιάζοντας για την επιχείρησή σας
Από την αρχή, πρέπει να σχεδιάσετε ένα προϊόν που είναι επωφελές για την επιχείρησή σας. Αυτό σημαίνει να σκέφτεστε πώς το προϊόν API σας θα αποφέρει χρήματα και πώς θα παρακολουθήσετε την αξία του για την επιχείρησή σας.
Υπάρχουν διάφορα στρατηγικές δημιουργίας εσόδων μπορείτε να χρησιμοποιήσετε, συμπεριλαμβανομένων των προγραμμάτων άμεσης και έμμεσης δημιουργίας εσόδων ή κατανομής εσόδων με τους καταναλωτές σας. Ωστόσο, όταν σχεδιάζετε το API σας, ανεξάρτητα από το μοντέλο δημιουργίας εσόδων που έχετε κατά νου, θα πρέπει να διασφαλίσετε ότι προσφέρετε υψηλή αξία στους πελάτες σας, διασφαλίζοντας παράλληλα ότι το κέρδος που πραγματοποιείτε καλύπτει το κόστος διατήρησης και εξέλιξης API και παροχή υποστήριξης στους καταναλωτές σας.
Θα πρέπει να διασφαλίσετε ότι η αξία που λαμβάνουν οι πελάτες σας από τη χρήση των API σας εκφράζεται σε εξοικονόμηση κόστους, αυξημένα κέρδη, χαμηλότερους κινδύνους ασφαλείας ή άλλες απτές μετρήσεις. Για να το κάνετε αυτό, πρέπει να δικαιολογήσετε την τιμή των API σας και το κόστος που κοστίζει σε χρόνο και προσπάθεια για τους πελάτες να ενσωματωθούν μαζί τους. Διαφορετικά, δεν θα έχει νόημα για τους καταναλωτές να ξεκινήσουν με τα API σας.
Σχεδιασμός για τους χρήστες σας
Κατά τη διαδικασία ανακάλυψης, μπορεί να συνειδητοποιήσετε ότι υπάρχουν πολλά τμήματα πελατών που διαφέρουν ως προς τις εργασίες που πρέπει να γίνουν, το μέγεθος του οργανισμού, τη βιομηχανία και ούτω καθεξής. Θα χρειαστεί να ορίσετε αυτά τα χαρακτηριστικά με ακρίβεια, καθώς είναι βασικά για την κατανόηση του μεγέθους της αγοράς και την ποσοτικοποίηση της επιχειρηματικής ευκαιρίας που παρουσιάζει το προϊόν API σας.
Πρέπει επίσης να κατανοήσετε πώς φαίνεται η επιτυχία για αυτούς τους πελάτες, καθώς και πώς σχεδιάζουν να τη μετρήσουν. Αυτές οι πληροφορίες είναι ζωτικής σημασίας για τον επιτυχημένο σχεδιασμό προϊόντων. Η κατανόησή τους θα βοηθήσει επίσης την ομάδα μάρκετινγκ να ορίσει το μοναδικό σημείο πώλησης (USP) με τρόπο που να ευθυγραμμίζεται με τους στόχους των πελατών σας.
Σε αντίθεση με τα προϊόντα ιστού, όπου μπορείτε να προσαρμόσετε δυναμικά τη διεπαφή χρήστη για ένα συγκεκριμένο κοινό, μια τέτοια επιλογή δεν είναι διαθέσιμη για REST API – αν και μπορείτε να αξιοποιήσετε τα GraphQL API και να αφήσετε τους πελάτες σας να καθορίσουν ποια πεδία στα API σας θα ήθελαν να χρησιμοποιήσουν!
Πρέπει να λάβετε υπόψη τις απαιτήσεις όλων των τμημάτων και να βρείτε ένα κοινό έδαφος για αυτές. Ταυτόχρονα, δεν υπάρχουν όρια στον τρόπο με τον οποίο μπορείτε να τοποθετήσετε και να προωθήσετε το προϊόν API σας. Για παράδειγμα, μπορείτε να δημιουργήσετε μηνύματα παρότρυνσης για δράση (CTA) ειδικά σχεδιασμένα για κάθε ένα από τα τμήματα του κοινού σας, όπως διαφορετικές δηλώσεις που εξηγούν τα οφέλη για τους πελάτες μεγάλων επιχειρήσεων ή τις μικρές και μεσαίες επιχειρήσεις (ΜΜΕ).
Σχεδιασμός για προγραμματιστές
Εκτός από το να σχεδιάζετε το προϊόν σας έχοντας κατά νου τα σημεία και τους στόχους των πελατών-στόχων σας, πρέπει να σκεφτείτε και αυτούς που θα χρησιμοποιήσουν το API σας – προγραμματιστές. Η έρευνα για την ωριμότητά τους, τις απαιτήσεις εξουσιοδότησης και τυχόν προτιμώμενες γλώσσες στον κλάδο τους σημαίνει ότι το προϊόν API σας μπορεί να σχεδιαστεί ώστε να ταιριάζει όμορφα με τις απαιτήσεις όσων θα το χρησιμοποιήσουν.
Μια πολύ σημαντική πτυχή αυτού είναι η πρόσβαση αυτοεξυπηρέτησης και τα εργαλεία εντοπισμού σφαλμάτων. Οι προγραμματιστές σας δεν μπορούν να υιοθετήσουν τα API σας εάν δεν μπορούν να έχουν πρόσβαση και να ενσωματωθούν σε αυτά. Αντίθετα, θα πλημμυρίσουν την υποστήριξη πελατών σας με αιτήματα για πρόσβαση, εναλλασσόμενα διαπιστευτήρια και ερωτήσεις που σχετίζονται με τον εντοπισμό σφαλμάτων, με αποτέλεσμα τόσο υψηλά λειτουργικά έξοδα όσο και χαμηλή υιοθέτηση. Σίγουρα δεν είναι ιδανικό.
Η κατανόηση αυτών των απαιτήσεων μπορεί επίσης να σας εξοικονομήσει χρόνο και προσπάθεια. Γνωρίζοντας ποιες γλώσσες προτιμούν οι χρήστες που σκοπεύετε, για παράδειγμα, σημαίνει ότι δεν θα χάσετε χρόνο δημιουργώντας SDK για γλώσσες που δεν ταιριάζουν στη συγκεκριμένη περίπτωση χρήσης του API σας.
Προσαρμογή του προϊόντος API στην αγορά σας
Πρώτα απ ‚όλα, πρέπει να σχεδιάσετε το προϊόν σας σε υψηλότερο επίπεδο: να ορίσετε τη ροή χρηστών, το USP και το μοντέλο τιμολόγησης. Στη συνέχεια, επικυρώστε την πρόταση αξίας σας με μια σειρά συνεντεύξεων με υπεύθυνους λήψης αποφάσεων. Πιθανότατα δεν θα ενδιαφέρονται για τον τεχνικό σχεδιασμό του προϊόντος σας, επομένως πριν προχωρήσετε σε αυτό, πρέπει να είστε σίγουροι ότι το προϊόν λύνει πραγματικά τα προβλήματα των πελατών σας. Εάν δεν το κάνει, δεν θα χρησιμοποιήσουν το προϊόν σας, ανεξάρτητα από το πόσο όμορφα είναι σχεδιασμένο από τεχνική άποψη.
Οι συνεντεύξεις σας με τους υπεύθυνους λήψης αποφάσεων θα πρέπει να επικεντρωθούν στην επικύρωση του οράματός σας για τη λύση και το επιχειρηματικό μοντέλο. Αρχικά, δημιουργήστε ένα βήμα πωλήσεων για να περιγράψετε το όραμά σας για το τι πιστεύετε ότι μπορεί να λύσει τα προβλήματα των πελατών σας.
Στη συνέχεια, ελέγξτε αν οι πελάτες σας είναι πρόθυμοι να αγοράσουν μια λύση από εσάς με βάση την προσφορά σας. Εάν ναι, ποιο εύρος τιμών είναι διατεθειμένοι να πληρώσουν; Αυτό μπορεί να είναι δύσκολο, επομένως είναι καλό να βρείτε ένα σύνολο προκαθορισμένων περιοχών για δοκιμή.
Μπορεί να απαιτεί επανάληψη πολλές φορές στη λύση σας προτού βρείτε μια καλή λύση για το πρόβλημα, αλλά αυτό θα αποδώσει όταν συντρίψετε την αγορά.
Το τεχνικό μέρος
Από τεχνική άποψη, πρέπει να σχεδιάσετε το API, συμπεριλαμβανομένων των τελικών σημείων, των μηχανισμών εξουσιοδότησης και ελέγχου ταυτότητας, των δομών δεδομένων, της ασφάλειας και ούτω καθεξής. Η τυποποίηση είναι σίγουρα φίλος σας εδώ, καθώς θα σας βοηθήσει να σχεδιάσετε ένα API που θα είναι διαισθητικό για τους προγραμματιστές να συνεργαστούν.
Δεν χρειάζεται να εφεύρετε ξανά τον τροχό όταν πρόκειται για σχεδιασμό API. Υπάρχουν πολλές λύσεις που μπορούν να σας βοηθήσουν να επιταχύνετε τη διαδικασία. Το Tyk Designer, για παράδειγμα, σας δίνει τη δυνατότητα σχεδιάστε το API σας από την αρχή ή εισαγάγετε το API σας μέσω της Προδιαγραφής OpenAPI (Swagger) για να ενεργοποιήσετε το CI/CD, με το πρόσθετο πλεονέκτημα της εύκολης τεκμηρίωσης του σχεδίου σας API.
Αφού έχετε εγκατεστημένες τις προδιαγραφές και τη ροή χρήστη για την πρόσβαση στο προϊόν API σας, πρέπει να ελέγξετε τη σκοπιμότητα της προδιαγραφής. Αυτό σημαίνει ότι πρέπει να κάνετε κράτηση για μια σειρά συνεντεύξεων με το κοινό των προγραμματιστών σας και να πραγματοποιήσετε δοκιμές εμπειρίας χρήστη (UX) και εμπειρίας προγραμματιστή (DX): παρουσιάστε στους προγραμματιστές τις προδιαγραφές και ρωτήστε τους πώς θα δημιουργήσουν τη ροή ενοποίησης με αυτήν. Είναι αρκετά τα παρεχόμενα τελικά σημεία για ενσωμάτωση; Χρειάζεται να μεταμορφώσουν τα δεδομένα πριν τα χρησιμοποιήσουν; Πρέπει να τα λάβετε υπόψη όλα αυτά για να εξασφαλίσετε την άψογη υιοθεσία.
Εάν σημειώσετε όλα τα σωστά πλαίσια σε αυτό το στάδιο, ήρθε η ώρα να προχωρήσετε στην παράδοση του API σας.
Παράδοση προϊόντος API
Όταν πρόκειται για την παράδοση του προϊόντος σας API, επιτυχία σημαίνει ότι το API κάνει ό,τι πρέπει, έχει σαφή, συνοπτική τεκμηρίωση και συνοδεύεται από μια υπηρεσία υποστήριξης με επίκεντρο τον πελάτη. Η σύνταξη σαφούς τεκμηρίωσης δεν αρκεί. Η τεκμηρίωση θα πρέπει να μιλά την ίδια γλώσσα τόσο με τους προγραμματιστές όσο και με τους υπεύθυνους λήψης αποφάσεων. Το να διαχωρίζετε την επιχειρηματική τεκμηρίωση από το γενικό περιεχόμενο μάρκετινγκ είναι το κλειδί για αυτό.
Κατά την εφαρμογή του API, το πρώτο βήμα για αυτό είναι να γράψετε τον κώδικα και να τον δοκιμάσετε διεξοδικά για να διασφαλίσετε ότι το API σας είναι αποτελεσματικό, αποδοτικό, ασφαλές και επεκτάσιμο. Δοκιμάστε, δοκιμάστε και δοκιμάστε ξανά για να βεβαιωθείτε ότι το προϊόν σας θα έχει την αναμενόμενη απόδοση μόλις δημοσιευτεί.
Η τεκμηρίωσή σας, εν τω μεταξύ, πρέπει να είναι ταυτόχρονα περιεκτική και συνοπτική. Θα πρέπει να καλύπτει όλα όσα θα χρειαστούν οι προγραμματιστές να υιοθετήσουν και να χρησιμοποιήσουν το API σας, συμπεριλαμβανομένης της αντιμετώπισης προβλημάτων, σε μια εύκολη στην παρακολούθηση μορφή.
Για να μην κυματίζει τη σημαία Tyk πολύ φανερά, αλλά μια ισχυρή, διαισθητική λύση διαχείρισης API μπορεί σίγουρα να βοηθήσει σε όλα αυτά.
Ένταξη προγραμματιστή
Αφού προσαρμόσετε τα πακέτα σας και δημοσιεύσετε το API σας, πρέπει να διασφαλίσετε ότι οι προγραμματιστές μπορούν να το ανακαλύψουν και να το αποκτήσουν πρόσβαση. Εδώ έρχεται μια πύλη προγραμματιστών. Μια πύλη προγραμματιστών μπορεί να παρουσιάσει τα προϊόντα API σας, συσκευασμένα μαζί με τεκμηρίωση που στοχεύει στα πρόσωπα ή/και τα τμήματα της αγοράς που επιθυμείτε. Πρέπει επίσης να διασφαλίσετε ότι οι προγραμματιστές σας μπορούν να ενσωματωθούν στα προϊόντα API σας. Όπως είπε κάποτε ένας σοφός, Οι κατάλογοι API οργανώνονται, ενώ οι πύλες προγραμματιστών παράγουν.
Οι προγραμματιστές πρέπει να μπορούν να βρουν το API σας και να κατανοήσουν τον σκοπό και τη λειτουργία του. Αυτό είναι το κλειδί για να καταστεί δυνατή η αυτοεξυπηρέτηση της ανακάλυψης και της κατανάλωσης του προϊόντος σας API – και αυτό είναι απαραίτητο εάν θέλετε να κλιμακωθείτε όσο το δυνατόν γρηγορότερα και ευρύτερα.
Πιθανότατα θα θέλετε επίσης να λανσάρετε το προϊόν API σας με φανφάρες και να το προωθήσετε στο κοινό-στόχο σας. Βεβαιωθείτε ότι το κάνετε με τρόπο που να ευθυγραμμίζεται με την ευρύτερη επιχειρηματική στρατηγική και τους στόχους σας, ώστε να διατηρείτε όλα τα μηνύματα στην επωνυμία.
Η πύλη προγραμματιστών αποτελεί αναπόσπαστο μέρος της προσφοράς σας API: η κακώς σχεδιασμένη ροή πρόσβασης ή η έλλειψη εργαλείων εντοπισμού σφαλμάτων αυτοεξυπηρέτησης θα έχει ως αποτέλεσμα την οδυνηρή υιοθέτηση, έναν αυξανόμενο αριθμό εισιτηρίων υποστήριξης ή και τα δύο. Αυτό σημαίνει ότι πρέπει επίσης να το δοκιμάσετε πριν το φέρετε στην αγορά.
Κλείστε μια σειρά συνεντεύξεων με τους προγραμματιστές σας και ζητήστε τους να περάσουν από τη διεπαφή της πύλης προγραμματιστών σας για να βεβαιωθείτε ότι η διεπαφή είναι καλά κατανοητή, ότι η ροή πρόσβασης δεν έχει καμία τριβή και ότι τα εργαλεία εντοπισμού σφαλμάτων αυτοεξυπηρέτησης είναι επαρκή.
Έτοιμοι, ορίστε, φύγετε!
Αυτό ήταν – έχετε κατακτήσει τα βασικά του σχεδιασμού και της παράδοσης προϊόντων API. Τότε το μόνο που χρειάζεται να κάνετε είναι να θέσετε σε εφαρμογή διαδικασίες για συντήρηση, βελτίωση, έκδοση εκδόσεων, υποστήριξη πελατών και όλα τα άλλα πράγματα που χρειάζεστε για να διατηρήσετε το προϊόν σας σχετικό και τους πελάτες σας ευχαριστημένους.
Αξίζει επίσης να σημειωθεί ότι πολλά από τα παραπάνω σημεία ισχύουν και για την εσωτερική ανάπτυξη API. Πρέπει ακόμα να σχεδιάζετε το API σας έχοντας κατά νου τους καταναλωτές, να παράγετε χρήσιμη τεκμηρίωση, να σχεδιάζετε με ασφάλεια, να παραδίδετε από άποψη απόδοσης και ούτω καθεξής.
Έχετε ερωτήσεις; Η ομάδα της Tyk είναι στην ευχάριστη θέση να μιλήσει για το πώς η λύση διαχείρισης API μπορεί να σας βοηθήσει να σχεδιάσετε και να παραδώσετε τα προϊόντα API σας. Μπορείτε επίσης να βουτήξετε κατευθείαν και να δοκιμάσετε μόνοι σας το Tyk χωρίς καμία δέσμευση. Γιατί να μην ξεκινήσετε το ταξίδι παραγωγής σας στο API αυτή τη στιγμή;
