Header Ads Widget

Ticker

6/recent/ticker-posts

Cómo los malos portales para desarrolladores acaban con las API

 


"Los documentos de referencia no constituyen portales para desarrolladores".

Este fue el meollo de una charla dada por el veterano de las API nórdicas y  CEO de Pronovix ,  Kristof Van Tomme,  en nuestra Cumbre de Plataformas 2017. Su opinión es que  los portales de desarrolladores deberían funcionar como centros de autoservicio para las API , permitiendo a los desarrolladores acceder a las API sin tener que esperar claves de acceso o cualquier información adicional.

Suena bastante simple a primera vista, pero no siempre funciona así en la práctica; muchos desarrolladores de API no ofrecen un portal para sus usuarios y algunos no ofrecen la información y los recursos adecuados para facilitar el uso de su API. Entonces, ¿por qué es ese el caso?

Un problema importante es que muchas organizaciones no saben qué incluir en un portal para desarrolladores debido a la falta de experiencia. Esto es especialmente cierto para las instituciones tradicionales como las de logística, aerolíneas, bancos, empaque y compañías de seguros, que están abriendo integraciones de socios API por primera vez.

"... muchas de estas industrias tradicionales son débiles a la hora de crear grandes experiencias para desarrolladores". Web programable

Otro problema frecuente es el hecho de que algunas empresas no creen que necesiten un portal para desarrolladores. Esto puede deberse a muchas razones: tal vez su API ya se esté utilizando, o tal vez no vean un problema con la aprobación manual de solicitudes para usar su API.

En esta publicación veremos cuán útil puede ser un buen portal para desarrolladores para agilizar el acceso a su API, así como también cómo no proporcionar la documentación adecuada puede dañar seriamente la experiencia de integración con él.

Este artículo se inspiró en la presentación de Kristof Van Tomme de la Cumbre de la Plataforma 2017. Diapositivas ] Míralo aquí:

Confiar

El primer punto de Kristof es que un portal para desarrolladores es más que una interfaz para su estrategia de API ; juega un papel clave como señal de confianza. Un portal de desarrolladores completo y actualizado dice que “ puedes confiar en nosotros, no vamos a desaparecer. No debe tener miedo de gastar esfuerzo y energía en la integración con nuestra API. "

Bromea diciendo que las API deberían tener portales para desarrolladores por la misma razón por la que los bancos todavía tienen grandes edificios elegantes, porque generan confianza. Si realmente confía o no en su banco es un tema completamente diferente, pero ciertamente no confiaría en un banco que tiene su sede en algún callejón en una zona deteriorada de la ciudad. De manera similar, para las extensiones bancarias en línea, los excelentes portales para desarrolladores son una parte fundamental de las  iniciativas de banca abierta que deben generar confianza con las FinTechs.

En otras palabras, " si no tiene el contenido adecuado, la gente no confiará en ti ". En este sentido, los portales para desarrolladores tienen mucho en común con cierto tipo de sitios de "características y beneficios" dirigidos a los consumidores.

Tome el sitio POS de Shopify , por ejemplo: el sitio presenta los 3 puntos de venta clave del servicio, 6 características, un simple desglose de los planes disponibles y un testimonio. Y, por supuesto, una foto de un cliente feliz. Compare esto con la página de características de FreeAgent : 9 características y puntos de venta, un panel de testimonios y un enlace a una página de precios con un desglose de planes muy similar.

Aunque el orden y los números exactos pueden diferir, verá el mismo formato en toda la web. Los diseñadores, redactores y probadores A / B han pasado incontables horas perfeccionando la fórmula perfecta para el contenido correcto, es decir, aquello que genere confianza.

Para obtener más información, lea: 7 elementos sin los que ninguna documentación de API puede vivir

Solución de problemas

Entonces, ¿cuál ES exactamente el contenido correcto? En el contexto de los portales de desarrolladores, parecería ser contenido que profundiza en los entresijos técnicos de la API en cuestión. En otras palabras, contenido que se ocupa de la resolución de problemas .

En su charla, Kristof describe ocho características clave que tienen los portales de desarrolladores más exitosos, y las que están en negrita son "imprescindibles":

  • Documentos de referencia
  • Aprovisionamiento rápido de claves de API
  • SDK (generados automáticamente, pero con alguna interacción manual cuando sea necesario)
  • Páginas de destino
  • Tutoriales
  • Guías para problemas específicos, incluidos casos de uso
  • Documentos conceptuales que explican términos difíciles / contrarios a la intuición
  • Blogs

Por cierto, señala que el último elemento de esa lista es opcional: “ Si no tienes personas que vayan a escribir en tu blog, no incluyas una; un blog vacío es peor que ningún blog. "

Notará que de lo anterior, al menos seis tratan de la experiencia de usar realmente su API, con blogs, páginas de destino y aprovisionamiento como posibles excepciones. Este último proporciona el acceso en sí mismo y los dos primeros suelen tratar temas más contextuales, como estudios de casos o estadísticas relacionadas con la API. Pronovix también enumera 11 preguntas que un MVP del portal de desarrolladores debe responder aquí .

En otras palabras, gran parte del contenido de un buen portal para desarrolladores debe diseñarse para abordar problemas potenciales que un usuario pueda tener cuando los encuentre. Eso significa que reducirá las solicitudes de soporte relacionadas con su API, lo cual es particularmente clave si no tiene miembros del equipo de soporte dedicados a las consultas relacionadas con la API (que pueden carecer del conocimiento especializado para responderlas de manera adecuada).

Lea también: Utilice las pruebas automáticas de documentación de API

Comunicación

Kristof se refiere al portal de desarrolladores como un " nexo de comunicación " , que en realidad es solo una forma elegante de decir que debería cerrar la brecha entre las personas que entienden lo que hace la API y las que no.

Kristof describe los portales para desarrolladores como un "nexo de comunicación"

En el contexto de la diapositiva anterior, por ejemplo, es probable que los desarrolladores , evangelistas y redactores de tecnología interactúen con ventas , soporte y marketing para garantizar que todos en la organización comprendan el valor de la API.

Kristof divide el ecosistema de API en industria, cliente, socio e interno. Si bien lo anterior cubre el aspecto interno del ecosistema de API, las API públicas también deben involucrar a las partes interesadas para los canales de comunicación externos.

“ Una señal de un equipo maduro es tener escritores de tecnología y evangelistas de desarrolladores ”, sugiere Kristof. Ciertamente tiene razón en que estas personas, junto con las ventas, el soporte y el marketing, generalmente serán las caras avanzadas que construyen relaciones para impulsar la adopción de API.

¿Quiere ayuda para generar documentos API? Aquí hay más de 30 soluciones de documentación de API

Pensamientos finales

Hemos visto anteriormente que hay mucho más en la calidad de la  experiencia del desarrollador que simplemente cargar algunas páginas de documentación técnica. Si bien es cierto que un buen portal para desarrolladores no puede salvar una mala aplicación, definitivamente es cierto que una mala experiencia del desarrollador puede descarrilar el uso de una gran API .

Con herramientas y servicios como Apigee Edge y servicios como el propio Pronovix de Kristof, que crea portales de desarrolladores personalizados , en el mercado es difícil imaginar algo que suplante al portal de desarrolladores. Por otra parte, es difícil imaginar un momento en el que las páginas de destino no siempre se ajustaran a la receta de características, beneficios, planes, testimonios ".

Una gran razón para pasar algún tiempo trabajando en su portal de desarrolladores, desde el punto de vista organizativo de todos modos, se resume claramente aquí :

"Tener la capacidad de analizar las métricas de participación de un portal de desarrolladores ... puede proporcionar información estratégica para un desarrollador evangelista y un gerente de producto al decidir cómo priorizar el gasto futuro en los recursos de la comunidad de desarrolladores".

En otras palabras, si se toma en serio su API, es hora de que también se tome en serio su portal de desarrolladores . Es muy posible que termine determinando hacia dónde se dirige su API.

Publicar un comentario

0 Comentarios