Teilen Sie:
){kind=small}
Lorna ist eine Software-Ingenieurin mit einer unheilbaren Blogging-Sucht. Sie versucht, Worte und Code gleichermaßen zu bändigen.
Was macht ein API-Produkt erfolgreich?
Lesedauer: 3 Minuten
Wir verbringen unsere Zeit nicht nur damit, ansprechende APIs für unsere Nutzer zu entwickeln, sondern nehmen auch an Veranstaltungen mit anderen API-Machern teil.
Im Oktober waren wir auf der APItheDocs in Amsterdam, um einige unserer eigenen Vorträge zu halten. Ein Vortrag, der uns sehr gefallen hat, war der Vortrag "What Makes an API Product Successful?" von Anthony Rouxund wir dachten, wir sollten eine Zusammenfassung des Vortrags mit Ihnen teilen.
Wenn Sie wirklich interessiert sind, können Sie sich das Video des Vortrags ansehen:
Anthonys Vortrag umfasste eine Reihe von Punkten (insgesamt acht), die seiner Meinung nach für den Erfolg einer API als Produkt wichtig sind. Wir hatten das Gefühl, dass einige davon wirklich mit unserer Arbeit übereinstimmen, und andere gaben uns einige Denkanstöße zu Dingen, die wir gerne verbessern würden. Alles in allem war es eine großartige Mischung von Punkten.
Indem Sie dafür sorgen, dass potenzielle Kunden Zugang zu allen Unterlagen haben, die sie für die Arbeit mit der Anwendung benötigen, können Sie ihr Vertrauen in Ihre API als Lösung stärken.
Unsere gesamte API-Referenzdokumentation ist auch als OpenAPI-Spezifikationen verfügbar. Wir hoffen, dass dies den Entwicklern hilft, sowohl bei der Erkundung unserer Angebote als auch bei der tatsächlichen Integration und Wartung der von ihnen erstellten Anwendungen mehr Klarheit zu schaffen.
Die Einbeziehung von Statusseiten, Preisen und Geschäftsbedingungen in die Kategorie "Offenheit ist erforderlich" ist eindeutig der Schlüssel für die Arbeit bei Amadeus, und das ist es auch für uns.
Wir sind sehr stolz auf unsere preisgekrönte* Dokumentation und unser Entwicklerportal https://developer.nexmo.com/ Wir kombinieren API-Referenzdokumente mit vielen Codeschnipseln für eine Vielzahl von Tech-Stacks, High-Level-Anleitungen und auch einige längere Tutorials, um eine bestimmte Anwendung Schritt für Schritt durchzuarbeiten.
*Wir sind wirklich preisgekrönt! Sehen Sie, ob Sie uns hier entdecken können https://pronovix.com/blog/devportal-awards-2019
Gestalten Sie den Anmeldeprozess sehr einfach und schnell, damit der Nutzer so schnell wie möglich mit der Erkundung beginnen kann.
Anthonys Rat, die Datenerhebung so weit wie möglich aufzuschieben, war sehr wertvoll. Er erinnerte mich auch an den einmaligen @cbettaan den Ratschlag von @cbetta aus einem anderen ausgezeichneten Vortrag, den ich letztes Jahr gesehen habe: "Stellen Sie sicher, dass Sie sich registrieren, um Ihre API oft zu nutzen!".
Ein Schlüsselelement der Entwicklererfahrung ist es, den Anmeldeprozess im Auge zu behalten und sich bewusst zu machen, wie der Benutzer ihn erlebt.
Anthonys "Dreier-Regel" für ein gezieltes Onboarding-Erlebnis:
3 Sekunden, um eine API zu verstehen
30 Sekunden, um einen Account zu erstellen
3 Minuten für den ersten API-Aufruf
Wenn doch nur alle APIs in diesem Sinne erstellt würden!
Das war sehr schön gemacht, und ich fand es gut, dass der Schwerpunkt auf der Verfügbarkeit von Open-Source und ausführbaren Codebeispielen lag.
Wir halten Sammlungen von ausführbaren Codebeispielen vor und fügen sie bei Bedarf in unsere Entwicklerdokumentation ein - mit einem Link zurück zum "echten" Code auf GitHub. Dies hilft uns bei der Pflege der Sammlung von Codebeispielen und ermöglicht es den Entwicklern, den Kontext des Codes zu sehen, wenn sie ihn benötigen.
Ein SDK kann die Arbeit eines Entwicklers bei der Integration mit einer API erheblich beschleunigen.
Wie wir hat auch Amadeus ausführliche API-Beschreibungen im OpenAPI-Format, und Anthony gab einige gute Ratschläge zur Balance zwischen automatisch generierten SDKs und ansprechenden, handwerklich gefertigten Lösungen. Mit unseren 6 (und einem inoffiziellen siebten) SDKs war ich ganz Ohr für diesen Abschnitt, und es war großartig, Erfahrungen von anderen zu hören, die ähnliche Probleme lösen.
Das Angebot einer begrenzten kostenlosen Testversion für alle API-Benutzer ist eine wirklich gute Möglichkeit, um Entwicklern zu helfen, Ihren Dienst zu untersuchen.
Möglicherweise gibt es eine niedrige Quote oder wir erlauben nur eine kleine Anzahl von Test-Telefonnummern, wenn sich ein Account in dieser Phase befindet. Entwickler haben oft keinen Zugang zur Kreditkarte des Unternehmens, wenn sie nur Prototypen erstellen. Stellen Sie also sicher, dass eine Karte keine Voraussetzung für Experimente ist!
Halten Sie das Preismodell einfach und bieten Sie eine Auswahl an Zahlungsmöglichkeiten an. Pay as you go funktioniert gut, vor allem für Kunden, die vielleicht klein anfangen und dann wachsen.
Der letzte Abschnitt ist ein Thema, das uns sehr am Herzen liegt: Unterstützung.
Machen Sie den Nutzern klar, wie sie Sie kontaktieren können, um Unterstützung zu erhalten, und wie sie Sie generell kontaktieren können.
Anthony empfahl nachdrücklich, öffentliche Plattformen für den Support zu nutzen, zum Beispiel, Stack Overflowzu nutzen, damit andere Nutzer dieselbe Antwort finden können, wenn Sie die Frage für einen Nutzer beantworten.
Er empfahl auch, eine FAQ zu verwenden und diese aktiv zu aktualisieren. Dies, zusammen mit allen möglichen Dokumentationsmerkmalen, wie z.B. einem klaren Feedback-Mechanismus, wird wirklich helfen, zu verstehen, wie die Erfahrung des Benutzers funktioniert.
Die Teilnahme an Veranstaltungen, bei denen es um unser Handwerk geht, aber auch der Kontakt mit Kunden ist für uns als Team sehr wichtig, da wir uns dadurch beruflich weiterentwickeln und mit Gleichgesinnten in Kontakt kommen (wir sind ja selbst ein großes Team!).
Dieser Vortrag war definitiv eine meiner Lieblingssitzungen auf der APItheDocs, danke, Anthony!