Partager:
){kind=small}
Lorna est une ingénieure en informatique qui a la manie incurable de bloguer. Elle tente d'apprivoiser les mots et le code à parts égales.
Qu'est-ce qui fait le succès d'un produit API ?
Temps de lecture : 4 minutes
En plus de passer notre temps à créer des API agréables pour nos utilisateurs, nous participons également à des événements avec d'autres créateurs d'API.
En octobre, nous étions à APItheDocs à Amsterdam pour présenter nos propres sessions. Nous avons beaucoup apprécié l'exposé intitulé "Qu'est-ce qui fait le succès d'un produit API ? Anthony RouxNous avons donc décidé de partager avec vous un résumé de cette présentation.
Si vous êtes vraiment enthousiaste, vous pouvez regarder la vidéo de la conférence :
Anthony a abordé une série de points (huit au total) qu'il jugeait importants pour la réussite d'une API en tant que produit. Nous avons eu l'impression que certains d'entre eux correspondaient vraiment au travail que nous faisons déjà et d'autres nous ont donné matière à réflexion sur des points que nous aimerions améliorer. Dans l'ensemble, c'était un bon mélange de points.
En vous assurant que les prospects peuvent accéder à toute la documentation dont ils auront besoin pour travailler avec l'application, vous pouvez renforcer leur confiance en choisissant votre API comme solution.
Toute notre documentation de référence sur les API est également disponible sous forme de spécifications OpenAPI et nous espérons que cela aidera également les développeurs à être plus clairs, à la fois lorsqu'ils explorent nos offres et lorsqu'ils procèdent à l'intégration et à la maintenance des applications qu'ils créent.
L'inclusion des pages de statut, de la tarification et des conditions générales dans la catégorie "l'ouverture est nécessaire" est clairement un élément clé du travail d'Amadeus, et c'est également le cas pour nous.
Nous sommes très fiers de notre documentation et de notre portail pour les développeurs, qui ont été primés*. https://developer.nexmo.com/ Nous combinons des documents de référence sur les API avec de nombreux extraits de code pour une variété de piles technologiques, des guides de haut niveau et également des tutoriels plus longs pour travailler sur une application particulière étape par étape.
*Nous sommes vraiment primés ! Voyez si vous pouvez nous repérer ici https://pronovix.com/blog/devportal-awards-2019
Faites en sorte que le processus d'inscription soit très simple et rapide afin que l'utilisateur puisse commencer à explorer le plus rapidement possible.
Le conseil d'Anthony de différer autant que possible la collecte des données a été très précieux. Il m'a également fait penser au seul et unique @cbettadans un autre excellent exposé que j'ai vu l'année dernière : "Assurez-vous que vous vous enregistrez pour utiliser votre API souvent !
Garder un œil sur le processus d'inscription et être conscient de la façon dont l'utilisateur le vit est un élément clé de l'expérience du développeur.
La "règle des trois" d'Anthony pour cibler l'expérience d'intégration :
3 secondes pour comprendre une API
30 secondes pour créer un Account
3 minutes pour effectuer le premier appel à l'API
Si seulement toutes les API étaient créées dans cette optique !
C'était très bien fait et j'ai apprécié l'accent mis sur la mise à disposition d'échantillons de code open-source et exécutables.
Nous conservons des collections d'échantillons de code exécutable et les intégrons dans notre documentation destinée aux développeurs lorsque nous en avons besoin - avec un lien vers le "vrai" code sur GitHub. Cela nous aide à maintenir la collection d'échantillons de code et permet également aux développeurs de consulter le contexte du code s'ils en ont besoin.
Le fait de disposer d'un SDK peut réellement accélérer le travail d'intégration d'un développeur avec une API.
Comme nous, Amadeus a des descriptions détaillées de ses API au format OpenAPI et Anthony a donné d'excellents conseils sur l'équilibre entre les SDK générés automatiquement et les solutions délicieuses, artisanales et faites à la main. Avec nos 6 (et une septième officieux), j'étais tout ouïe pour cette section et j'ai été ravie d'entendre les expériences d'autres personnes résolvant des problèmes similaires.
Offrir un essai gratuit limité à tous les utilisateurs de l'API est un très bon moyen d'aider les développeurs à étudier votre service.
Il peut y avoir un faible quota ou, par exemple, nous n'autorisons l'utilisation que d'un petit nombre de numéros de téléphone de test lorsqu'un Account se trouve dans cette phase. Les développeurs n'ont souvent pas accès à la carte de crédit de l'entreprise lorsqu'ils ne font que du prototypage, alors assurez-vous que le fait de disposer d'une carte n'est pas une obligation pour faire quelques expériences !
Veillez à ce que le modèle de tarification soit simple et proposez un choix de méthodes de paiement. Le paiement au fur et à mesure fonctionne bien, en particulier pour les clients qui commencent modestement et se développent par la suite.
La dernière section porte sur un sujet qui nous tient à cœur : le soutien.
Indiquez clairement aux utilisateurs comment ils peuvent vous contacter pour obtenir de l'aide et comment ils peuvent vous contacter en général.
Anthony recommande vivement d'utiliser les plateformes publiques pour obtenir de l'aide, par exemple, Stack Overflowafin que lorsque vous répondez à la question d'un utilisateur, d'autres utilisateurs puissent trouver la même réponse.
Il a également recommandé d'utiliser une FAQ et de la mettre à jour activement. Ces éléments, ainsi que toutes sortes de caractéristiques de la documentation telles qu'un mécanisme de retour d'information clair, aideront vraiment à comprendre comment l'expérience de l'utilisateur se déroule.
Il est très important pour nous, en tant qu'équipe, d'être présents lors d'événements concernant notre métier ou simplement pour interagir avec les clients ; cela nous permet de poursuivre notre développement professionnel et nous met en contact avec nos pairs (et même plus, nous sommes une grande équipe à nous seuls !).
Cette présentation a été l'une de mes sessions préférées d'APItheDocs, merci Anthony !