¿Qué hace que un producto API tenga éxito?

Además de dedicar nuestro tiempo a crear API encantadoras para nuestros usuarios, también participamos en eventos con otros creadores de API.

En octubre, estuvimos en APItheDocs en Ámsterdam para presentar algunas sesiones propias. Una de las charlas que más nos gustó fue la titulada "¿Qué hace que un producto API tenga éxito?" de Anthony Rouxasí que hemos pensado en compartir un resumen de la charla.

Si tiene muchas ganas, puede ver el Video de la charla:

La charla de Anthony abarcó una serie de puntos (ocho en total) que él consideraba importantes para el éxito de una API como producto. En nuestra opinión, algunos de ellos coincidían con el trabajo que ya estamos realizando y otros nos hicieron reflexionar sobre aspectos que nos gustaría mejorar. En general, fue una gran mezcla de puntos.

Sea abierto

Si se asegura de que los clientes potenciales pueden acceder a toda la documentación que necesitarán para trabajar con la aplicación, aumentará su confianza a la hora de elegir su API como solución.

Toda nuestra documentación de referencia de API también está disponible como especificaciones OpenAPI y esperamos que eso también ayude a los desarrolladores a tener más claro tanto cuando exploran nuestras ofertas como cuando realizan la integración y el mantenimiento reales de las aplicaciones que crean.

Incluir las páginas de estado, precios y términos y condiciones en la categoría "se requiere apertura" es claramente clave para el trabajo en Amadeus, y también lo es para nosotros.

Documentación

Estamos muy orgullosos de nuestro galardonado* portal de documentación y desarrollo https://developer.nexmo.com/ Combinamos documentos de referencia de la API con numerosos fragmentos de código para una gran variedad de pilas tecnológicas, guías de alto nivel y también algunos tutoriales más extensos para trabajar paso a paso con una aplicación concreta.

*¡Realmente somos premiados! A ver si nos localizas aquí https://pronovix.com/blog/devportal-awards-2019

Incorporación

Haga que el proceso de registro sea muy fácil y rápido para que el usuario pueda empezar a explorar lo antes posible.

El consejo de Anthony de aplazar todo lo posible la recogida de datos fue muy valioso. También me hizo pensar en el inigualable @cbettade otra excelente charla que vi el año pasado: "Asegúrate de registrarte para usar tu API a menudo".

Vigilar el proceso de registro y ser consciente de cómo lo experimenta el usuario es un elemento clave de la experiencia del desarrollador.

La "Regla de tres" de Anthony para la experiencia de incorporación:

• 3 segundos para entender una API

• 30 segundos para crear una Account

• 3 minutos para realizar la primera llamada a la API

Ojalá todas las API se crearan teniendo esto en cuenta.

Ejemplos y demostraciones

Estuvo muy bien hecho y me gustó la insistencia en disponer de ejemplos de código abierto y código ejecutable.

Mantenemos colecciones de ejemplos de código ejecutables y los incorporamos a nuestra documentación para desarrolladores cuando los necesitamos, con un enlace al código "real" en GitHub. Esto nos ayuda a mantener la colección de muestras de código y también permite a los desarrolladores ver el contexto del código si lo necesitan.

SDKs

Disponer de un SDK puede acelerar mucho el trabajo de un desarrollador a la hora de integrarse con una API.

Al igual que nosotros, Amadeus cuenta con descripciones detalladas de sus API en formato OpenAPI y Anthony dio algunos consejos estupendos sobre el equilibrio entre los SDK autogenerados y las soluciones deliciosas, artesanales y hechas a mano. Con nuestros 6 (y un séptimo no oficial) SDKs, yo era todo oídos para esta sección y fue genial escuchar experiencias de otros que resuelven problemas similares.

Prueba gratuita

Ofrecer una prueba gratuita limitada a todos los usuarios de la API es una muy buena forma de ayudar a los desarrolladores a investigar su servicio.

Puede haber una cuota baja o, por ejemplo, sólo permitimos el uso de un pequeño número de números de teléfono de prueba cuando una Account está en esta fase. Los desarrolladores no suelen tener acceso a la tarjeta de crédito de la empresa cuando solo están creando prototipos, así que asegúrate de que tener una tarjeta no sea un requisito para experimentar un poco.

Modelo de precios

El modelo de precios debe ser sencillo y ofrecer varias formas de pago. El pago por uso funciona bien, sobre todo para los clientes que empiezan con poco y luego van creciendo.

Ayuda

La última sección es un tema que nos toca muy de cerca: el apoyo.

Explique claramente a los usuarios cómo pueden ponerse en contacto con usted para solicitar asistencia y cómo pueden ponerse en contacto con usted en general.

Anthony recomendó encarecidamente utilizar plataformas públicas de apoyo, por ejemplo Stack Overflowpara que cuando respondas a la pregunta de un usuario, otros usuarios puedan encontrar la misma respuesta.

También recomendó utilizar un FAQ y actualizarlo activamente. Esto, junto con todo tipo de características de la documentación, como un mecanismo de retroalimentación claro, ayudará realmente a entender cómo está funcionando la experiencia del usuario.

Estar presentes en eventos sobre nuestro oficio, así como simplemente interactuar con los clientes, es realmente importante para nosotros como equipo; continúa nuestro desarrollo profesional y nos pone en contacto con nuestros compañeros (incluso con más de ellos, ¡somos un equipo grande nosotros solos!).

Esta charla fue sin duda una de mis sesiones favoritas de APItheDocs, ¡gracias, Anthony!