Breaking

Post Top Ad

Your Ad Spot

sábado, 25 de enero de 2020

3 pasos para preparar su API para el consumo

"Nos gusta pensar que somos una empresa de tecnología, pero comenzamos como una empresa de servicios".
Así es como Bo Li de ADP, un proveedor de software de nómina y recursos humanos con más de 740,000 clientes, abrió su discurso en nuestra Cumbre API 2019 en Austin . Se dice como un comentario casual, pero es un microcosmos para la línea que todas las compañías API caminan: el equilibrio entre hacer cosas útiles con la tecnología y preparar adecuadamente esas cosas útiles para el consumo público .
Li es responsable de ADP Marketplace, que proporciona API que los desarrolladores pueden usar para integrarse con los sistemas ADP. Luego pueden crear soluciones y venderlas en la plataforma de ADP. Actualmente, Marketplace cuenta con 300 aplicaciones conectadas con un total de 800 proveedores en proceso de integración.
Su perspectiva es invaluable porque, al trabajar con cientos de desarrolladores de API, ha podido identificar una tonelada de problemas frecuentes que comparten. Algunos encuentran grandes obstáculos, pero, como veremos a continuación, también hay muchos más pequeños y menos obvios.
Mira a Bo Li hablar en la Cumbre de Austin de los países nórdicos de 2019:

Todo es tecnología (y negocios)

La creación de una API interna , o una diseñada para ser utilizada por un grupo muy pequeño de personas con las que está en contacto cercano, es muy diferente a la preparación de una que sea de acceso público y utilizada regularmente por una gran cantidad de personas.
En el primer caso, es bastante fácil para los usuarios enviar un correo electrónico o llamar al desarrollador de la API en cuestión, o incluso pasar por su escritorio al regresar de la máquina de café, para preguntar cómo funciona algo. La mayoría de las API superan rápidamente esta fase, por lo que la documentación exhaustiva es tan importante.
Además, el tiempo de inactividad puede no ser un problema tan grande para las API que se usan internamente. Sin embargo, a medida que crece el apetito por una API en particular, también lo hace el riesgo real de que el tiempo de inactividad y otros problemas, por pequeños que parezcan, puedan afectar negativamente a las empresas de los consumidores de esa API.
En ambas situaciones, la API se trata más como un proyecto favorito que como un brazo legítimo del negocio. Eso lleva a otro problema importante, a saber, la expectativa de que los consumidores API se preocupen por su producto tanto como usted. Li explica que los desarrolladores de API a menudo "se implementan en un mercado y luego, después de unos meses, dicen 'hmm, ¿por qué nadie está prestando atención a mi API?'"
Este problema es tan importante que Li ha intentado desarrollar un proceso para que los desarrolladores de API puedan resolverlo. Además de hacer preguntas que son útiles para ADP: “¿Cómo protege su API? ¿Cómo protege sus datos? ¿Qué tan grande es el tamaño de su carga útil? ”, Pide a los usuarios que hagan la siguiente pregunta:“ ¿Qué problema resuelve su API? "
Solo cuando los desarrolladores de API piensan en su producto desde una perspectiva comercial  pueden comenzar a vocalizar por qué la API es digna de consumo. A continuación, hay otras tres formas en que puede hacer que su API sea digna de consumo.

1. La documentación es el rey

“Cuando los desarrolladores piensan en la documentación, piensan en Swagger, OpenAPI, etc., y eso es genial. Pero la especificación API y la documentación del producto son dos cosas muy diferentes ", dice Li.
Cuando las especificaciones y la documentación  se tratan como si fueran lo mismo, el resultado es una desconexión entre lo que prometen las especificaciones y lo que el desarrollador de API realmente ofrece. Para decirlo de otra manera, "la documentación de la API debe abordarlo todo ".
“Piense en el viaje de descubrir una API, evaluarla y luego determinar si satisface las necesidades de alguien y realmente usarla. En ese viaje participan muchas personas diferentes ”, dice Li.
Li proporciona un ejemplo de cómo se puede evaluar la idoneidad de una API típica. En lugar de un desarrollador, el primer punto de contacto puede ser un empresario no técnico. Probablemente les importará menos la carga útil y el tiempo de respuesta que los datos que proporciona.
Aquellos que busquen una API desde una perspectiva comercial tendrán requisitos muy diferentes de alguien con una mentalidad más tecnológica o de un desarrollador que esté pensando en tratar de trabajar con la API en sí. Li sugiere que un gran portal de desarrolladores en realidad debería dirigirse a un público más amplio que solo los desarrolladores .
El portal Apigee de Google es un buen ejemplo de esto, ya que comunica el valor de las experiencias de marca y cuantifica cómo el servicio aumenta la adopción de API además de los aspectos técnicos.
Relacionado: Cómo tratar su API como un producto

2. Crear una propuesta de valor

"No todas las API son iguales, y no todas están construyendo para el mismo propósito".
Suena bastante sencillo pero, como destaca Li, los desarrolladores de API no siempre tienen esto en cuenta al pensar en el valor de una API. Ella proporciona el siguiente ejemplo:
"Cuando se utiliza una API para igualar un producto o servicio ofrecido por un competidor, poner una cifra en dólares en la API [es decir, cobrar por ella] puede no ser la idea correcta".
Hay tres factores a tener en cuenta al intentar calcular la propuesta de valor de una API:
  • Valor : ¿lo entrega a través de cada transacción? ¿Cómo se traduce en estrategia de precios?
  • Costo : tenga en cuenta tanto el costo operativo / plataforma como el costo humano, por ejemplo, soporte, etc.
  • Términos comerciales : ¿se deben considerar las limitaciones de uso / volumen de llamadas o los precios escalonados?
Habiendo hablado sobre la diferencia entre las personas que pueden estar evaluando la idoneidad de un API, Li revisita la idea de disparidad, esta vez enfocándose en cómo se relaciona con aquellos que consumirán el API.
Sabemos que diferentes consumidores tienen diferentes necesidades, pero es importante mantener esto en la vanguardia de su mente para que pueda atenderlos como organización. Li proporciona ejemplos de aquellos que están construyendo APIs internas y externas y clientes (desarrolladores que usan APIs para construir sistemas para su propio uso) versus consumidores vendedores (compañías de terceros que intentan construir una solución para vender a los clientes).
Dependiendo del consumidor objetivo, diferentes situaciones requerirán diferentes términos comerciales, políticas, documentación, etc. Eso también, inevitablemente, tendrá un impacto en su estructura de precios. Es por eso que tantos productos tienen niveles personales, de pequeñas empresas y empresariales.
Más sobre documentos de API: 5 ejemplos de excelente documentación de API (y por qué pensamos eso)

3. Compromiso organizacional

Ya hemos cubierto el hecho de que los compradores y los tomadores de decisiones que buscan la idoneidad de una API pueden no ser desarrolladores. Como dice Li, "es posible que los equipos de TI les hayan dicho que, cuando validen una solución, 'se aseguren de que tengan API'".
Ella habla sobre cómo los vendedores deben sentirse cómodos hablando sobre las API, así como las ventajas que ofrecen, y cómo los equipos de soporte deberían ser capaces de "hablar sobre las API, replicar problemas y comprender cuándo surge un problema qué datos tienen que capturar para pasar esa información corriente abajo a un desarrollador ".
Para una empresa que crea una API, facilitar la aceptación de la organización significa:
  • Capturando la información necesaria para la resolución de problemas
  • Identificar y asignar responsabilidades por problemas
  • Iniciar sesión en todas las capas y estandarizar los mecanismos de registro, cuando sea posible, para obtener una imagen completa
  • Información más detallada sobre el manejo de excepciones, presentada de una manera fácil de usar
“Como parte de cualquier programa de implementación de API, necesitamos alinear a [los desarrolladores], el marketing y las personas de servicio. De lo contrario, toda la economía API no fluye ".
También destaca el componente de preparación organizativa en curso: "es importante preparar a los miembros del equipo cuando se implementa una API por primera vez, pero también es importante prepararlos para cada paso del ciclo de vida".
En otras palabras, cosas como nuevas versiones y características deben ser informadas internamente. Eso es especialmente importante, dice Li, cuando ya hay personas que usan la API; ¿Cómo llegaremos a estos usuarios con noticias sobre la API y quién lo hará?

Pensamientos finales

En su tiempo trabajando con 300 desarrolladores de API, estamos bastante seguros de que, incluso si es demasiado educada para admitirlo, Bo Li ha encontrado muchos ejemplos de lo que no debe hacer al preparar una API para el consumo. Como resultado, tiene una gran cantidad de información sobre las mejores prácticas y recomendaciones para desarrolladores que buscan lanzar una API.
En pocas palabras, estos se reducen a tres puntos clave:
  • Usar una especificación API no es suficiente cuando se trata de documentación efectiva
  • Considera lo que los diferentes grupos demográficos quieren saber cuando investigan tu API
  • Sin el compromiso de la organización, una API está condenada al fracaso o al estancamiento
Por supuesto, hay más para crear una API exitosa que seguir solo estos consejos. Pero, a menos que tenga en cuenta esta información a medida que avanza, es poco probable que llegue lo suficientemente lejos como para descubrir qué es eso.

No hay comentarios.:

Publicar un comentario

Dejanos tu comentario para seguir mejorando!

Post Top Ad

Your Ad Spot

Páginas