Header Ads Widget

Ticker

6/recent/ticker-posts

5 consejos para comenzar su viaje de API públicas

 

5 consejos para comenzar su viaje hacia la API y lanzar una API pública

Nuevas API públicas llegan al mercado todo el tiempo. Detrás de estas API se encuentran una gran cantidad de proveedores diferentes; desarrolladores individuales, nuevas empresas y empresas establecidas que han llegado a la conclusión de que necesitan un programa API público para atender mejor a su audiencia. Sin duda, estos nuevos proveedores de API tendrán diferentes ideas sobre cómo iniciar un programa público de API, las implicaciones para su negocio y lo que implican sus planes futuros para expandir o mejorar su API. En esta publicación, hemos reunido 5 consejos para iniciar un programa de API público , con algunos consejos sobre qué considerar cuando se pasa de cero a una implementación de API de producción.

Iniciar un programa de API público es un tema enorme y solo estamos rascando la superficie en esta publicación. En aras de la brevedad, también ignoramos el hecho de que las organizaciones también se ven obligadas a crear programas API públicos a través de regulaciones como la Directiva de servicios de pago 2 . Por supuesto, algunos de estos consejos aún se aplican.

Revise estos puntos para ver si realmente necesita una API
1. Aclare sus necesidades

En primer lugar, antes de hacer un fragmento de trabajo, su primera tarea es aclarar que su organización realmente necesita un programa API público. Esto es enormemente subjetivo dado el espectro de organizaciones interesadas en las API, desde bandas de un solo hombre hasta grandes corporaciones multinacionales, y se ve agravado por las diferentes motivaciones detrás de la construcción de una API . Tan pronto como su programa API se considere necesario, deténgase y hágase estas preguntas:

  • ¿Mi producto / plataforma se beneficiaría de tener una API? : Hay muchas razones convincentes para iniciar un programa de API: permitir que los clientes decidan cómo consumen sus productos, extender el alcance de su producto a los clientes de sus clientes y habilitar nuevos canales comerciales con socios, por nombrar solo algunos. Independientemente de la exageración que rodea a las API, si puede decir objetivamente que sí a cualquiera de estas razones, entonces vale la pena investigar el inicio de un programa API;
  • ¿Mis clientes me piden que les entregue mi producto / plataforma de manera diferente (especialmente a través de una API)? : Gran parte del clamor por ofrecer una API vendrá de la base de usuarios. Una vez más, habrá una gran cantidad de subjetividad e interés propio en sus razones para pedir uno: algunos preguntarán simplemente porque han escuchado el término y notaron que algunos de sus competidores lo ofrecen; mientras que otros tendrán una necesidad genuina, como el deseo de integrar su producto con otras aplicaciones que utilizan. La integración de su pila de productos en sus flujos de trabajo es desconectada y manual, por lo que la integración a través de una API es muy ventajosa. Ambas son razones de peso para actuar: si no tiene una API, pero sus competidores la tienen, ¿qué impide que su cliente haga negocios con ellos?
  • ¿Entiendo el efecto que tendrá la introducción de una API en mi negocio (tanto bueno como malo)? : Es posible que su organización se vea profundamente afectada por la introducción de una API. Por ejemplo, una API puede cambiar el modelo operativo de su negocio de solo horario diurno a un funcionamiento 24 × 7, o puede ser tan transformador como para convertir su negocio en un modelo de Infraestructura como servicio '. Uno solo necesita mirar a Amazon para ver cuán disruptivo podría ser el efecto de crear un programa de API público en su negocio.

Si puede responder estas tres preguntas de manera positiva, entonces comenzar un programa API definitivamente redunda en el interés de su organización. Su tarea ahora es conseguir la compra al por mayor de las partes interesadas en el negocio.

conectividad empresarial roadsign que lanza api pública
2. Obtenga la participación (de todos)

Como comenzamos a discutir en el consejo n. ° 1, debe tener claro que, a menos que su API sea el canal principal para vender el producto que está construyendo, iniciar un programa de API podría cambiar fundamentalmente la forma en que opera su negocio. Por ejemplo:

  • Su API podría desintermediar partes de su propio negocio (por ejemplo, si depende en gran medida de las ventas directas). ¿Está el equipo de liderazgo preparado para las implicaciones que esto podría tener en la fuerza laboral?
  • Si proporcionar una API impulsa el volumen, ¿puede su empresa hacer frente a ese volumen adicional sin cambios?
  • ¿Tiene el equipo y los recursos para crear código adaptable y escalar sus relaciones con los desarrolladores para que la API se trate como un producto a gran escala?
  • ¿Sus sistemas de backend que serán expuestos por la API tienen los medios para admitir un modelo de seguridad abstracto o un proveedor de identidad, y está consciente de lo que esto significará para la amenaza de ciberataques y la gestión de riesgos?

Para tener éxito en el inicio de su programa API, necesita que todos los miembros del equipo comprendan que está extendiendo efectivamente sus sistemas internos hacia afuera . El impacto tendrá un enfoque tanto técnico como comercial, por lo que es importante comunicarse de una manera que cada parte interesada comprenda. Fomentar una cultura de seguridad y adoptar una mentalidad API en toda la organización es vital para el éxito.

3. Apunta a un MVP público

desarrollo iterativo al lanzar api pública

Con la necesidad establecida y el equipo a bordo, debe tener una idea clara de por qué está creando una API pública y quiénes deben participar. Ahora puede crear una visión de lo que ofrecerá su API en forma de un producto mínimo viable (MVP), entregado al mercado como alfa o beta. Este MVP le permitirá presentar su API a los consumidores potenciales de API lo más rápido posible y le permitirá comenzar a recopilar comentarios. El MVP son los pasos 1 y 2 de un proceso de 3 pasos:

  1. Construcción inicial del MVP solo con pruebas privadas internas ;
  2. Ofrecer el MVP a una audiencia selecta de clientes o socios existentes que tienen el potencial de convertirse en consumidores de su API;
  3. Migración del MVP a una versión de la API lista para producción, lista para disponibilidad general .

Para aprovechar al máximo su objetivo de ofrecer una API pública, el MVP debe constar de varias cosas:

  • Un punto final disponible públicamente o una caja de arena simple que los consumidores potenciales de API pueden usar para probar sus productos, con inscripción ya sea por invitación o con un conjunto de credenciales de prueba conocidas solo por su público objetivo;
  • Una descripción de API en un formato de especificación de su elección (OpenAPI, API Blueprint, RAML, etc.);
  • Documentación, posiblemente en forma de libro de cocina que describe cómo implementar una aplicación que consume su API;
Consulte nuestra publicación sobre cómo reducir el tiempo de incorporación para sus consumidores de API para ver qué debe incluirse en su libro de cocina o tutorial.
  • Un modelo de seguridad bien formado para que los consumidores potenciales de API comprendan las implicaciones de la integración con su API;
  • Establezca un medio para ayudar a los consumidores de API que están probando la API a través de un medio de su elección: Twitter, Slack, correo electrónico o lo que tenga más sentido para su organización;
  • Analice cómo lo utilizan quienes prueban su API en un esfuerzo por comprender si hay posibles fallas de diseño;
  • Términos de uso de alto nivel para que los consumidores de API estén al tanto de las expectativas que rodean el uso de su API: si hay estipulaciones que pueden desanimar a ciertos consumidores, probablemente sea mejor que no sean parte de su audiencia cuando presente el MVP.

Con el MVP disponible para los consumidores potenciales de API, puede aprovechar el siguiente consejo: actuar en función de los comentarios.

4. Actuar sobre la base de los comentarios

aceptar comentarios de los usuarios publicar api pública

Con el MVP en el mercado y los canales de comunicación con el equipo de API en su lugar, tiene una oportunidad única de obtener comentarios y actuar sobre ellos antes de un lanzamiento público. Su API, por supuesto, continuará evolucionando, pero con esta retroalimentación temprana, tiene la libertad de realizar elementos de reingeniería total. Estas acciones pueden incluir una o más de las siguientes:

  • Revise el diseño de la API y asegúrese de que esté actualizado para reflejar cualquier comentario sobre la usabilidad;
  • Asegúrese de escuchar las demandas razonables de los clientes para diferentes tipos de codificación: la mayoría de las nuevas API usan JSON como codificación de su elección, pero si tiene sentido proporcionar los datos como XML porque la mayoría de sus consumidores potenciales de API prefieren XML por razones heredadas , debería considerarlo;
  • Asegúrese de que los límites de velocidad y la aceleración que introdujo con su MVP puedan mantenerse de manera realista cuando se aplica un mayor uso;
  • Modifique sus condiciones de uso para asegurarse de dirigirse correctamente a su público objetivo, brindando a sus consumidores de API los términos con los que están felices de comprometerse, pero también permitiendo que el negocio se mantenga a medida que crece su API.

Al realizar estas acciones, estará en un lugar mucho mejor para lanzar la versión 1.0 de su API. Sin embargo, tiene que pensar en la versión 1.1, 1.2 o incluso la 2.0; Otro punto de nuestro arsenal de consejos para crear un programa de API público es preparar su organización para el futuro mediante la creación de una práctica de API que pueda admitir versiones futuras.

Para obtener una vista de cómo las API evolucionan continuamente, consulte nuestra publicación Su API nunca se publica por completo

Cree una práctica de excelencia al planificar una versión de API pública
5. Desarrolle su práctica

Construir una práctica de API es similar a crear un centro de excelencia o comunidad de práctica como en cualquier otra disciplina tecnológica o arquitectónica. Sin embargo, la práctica de las API debe orientarse hacia un método para desarrollar API que garantice que puede pasar de cero a producción con una serie conocida de estándares y metodologías y con el mínimo esfuerzo. Algunos principios de esta práctica son:

  • Expresar una visión clara de la API y la hoja de ruta de funciones, lanzamientos y mejoras que ayudarán a su empresa a cumplir esa visión;
  • Cree una arquitectura y un marco de desarrollo que respalde la productividad y le permitirá iterar rápidamente en los elementos de su hoja de ruta: utilizando prácticas como el diseño de API primero con un formato de descripción de API que mejor se adapte a sus necesidades y posiblemente una herramienta como Stoplight para ayudar a modelar su Las API le brindarán una mejor oportunidad de ofrecer nuevas API y versiones de API con la mayor eficiencia;
  • Cree una guía de estilo interna para sus desarrolladores de API que pueda respaldar sus esfuerzos de productividad al hacer que los diseños de API sean consistentes;
  • Aproveche al máximo su infraestructura y herramientas de DevOps: las opciones para elegir un enfoque para el desarrollo de API son amplias e incluyen diferentes modelos; Herramientas de gestión del ciclo de vida de API basadas en SaaS, marcos de aplicaciones web y PaaS, contenedores, etc. Sin embargo, cualquier opción que sea adecuada para su organización garantizará que aproveche el valor de la integración continua y la entrega continua para ayudar realmente a acelerar la entrega;
Para obtener más información sobre las herramientas de DevOps en un contexto de API, consulte nuestro libro electrónico .
  • Mantenga informados e involucrados a sus partes interesadas internas: puede haber aspectos de su hoja de ruta que dibujen nuevas áreas del negocio bajo el banner de API y, por lo tanto, afecten a diferentes equipos operativos o de soporte. Tener líneas claras de comunicación y compromiso con estos equipos es vital para el éxito continuo de su API;
  • Comuníquese externamente: su MVP ha sido un éxito y ha comenzado a interactuar con su público objetivo, pero hay un impulso que debe mantenerse. Asegúrese de comunicar sus objetivos a esta audiencia de una manera que amplíe la red; publique artículos y blogs que ensalcen el valor de su API en el contexto de la industria en la que opera y asegúrese de abordar técnicas de descubrimiento como la optimización de motores de búsqueda y la creación de marcadores de directorio para sus páginas de documentación para que los clientes potenciales puedan encontrar fácilmente su API.

Pensamientos finales

Los consejos que hemos reunido en esta publicación deberían ayudarlo a dar forma a su pensamiento si está considerando iniciar un programa público de API. Sin embargo, las circunstancias y motivaciones de cada empresa u organización son únicas, por lo que lo más importante es que confíe en sus instintos . Las API son un gran método para llevar productos al mercado, así que confíe en su propio juicio y utilice los consejos que pueda de esta publicación para ayudar a hacer realidad su programa público de API.

Publicar un comentario

0 Comentarios