Header Ads Widget

Ticker

6/recent/ticker-posts

7 pasos para crear productos API exitosos

 


Vivimos en una era en la que la información genera un valor extremo y las empresas buscan cada vez más nuevas formas de facilitar una mejor intercomunicación de datos entre aplicaciones internas, así como abrir sus reservas de datos para ingresar a la economía de la plataforma .

Según un informe publicado por Accenture en 2016 , el 81% de los ejecutivos dice que los modelos de negocio basados ​​en plataformas serán fundamentales para su estrategia de crecimiento dentro de tres años. Las API son clave para esta nueva era de transformación digital . Las API son consumidas por desarrolladores de diversas industrias con diferentes necesidades, y están bajo una presión constante para crecer y evolucionar sus servicios a medida que la empresa y el mercado maduran.

Con tal dinámica entre las necesidades del consumidor y la dinámica del mercado, está claro que las API ya no pueden tratarse como artefactos tecnológicos habituales, sino que deben tratarse con la misma atención y planificación que cualquier producto de primera clase . Es por eso que un enfoque de gestión de productos es importante para aprovechar el verdadero potencial de una oferta de API y ofrecer un servicio atractivo sin el cual los desarrolladores internos y externos no pueden vivir.

Con el fin de desarrollar un enfoque centrado en el consumidor y orientado al producto, hemos desarrollado un marco simple para pensar en todo el desarrollo y la entrega de API . Cada uno de estos pasos probablemente merece su propio artículo, y he compartido algunos recursos adicionales al detallar estos pasos que pueden ayudarlo en su viaje para crear una API increíble.

Paso 1: Comprenda el propósito de su API

¿Qué problema promete resolver su oferta de API? Tener un enfoque basado en resultados para el desarrollo de API puede ayudarlo a definir mejores métricas de éxito, construir una estrategia de desarrollo sostenible y escalable y facilitar una aceptación más rápida de las partes interesadas. Algunos casos de uso famosos de API incluyen:

  • Facilitar un desarrollo más rápido y crear una arquitectura adaptable al exponer todos los servicios internos a través de API - Amazon
  • Creación de una plataforma exitosa para impulsar una mayor participación de los usuarios: Facebook
  • Aumente el tráfico al sitio web principal incentivando el envío de usuarios a través de un modelo de API de socio - eBay

Es importante comprender completamente el propósito de su API para ver cómo se relaciona con su taxonomía comercial. Esta taxonomía se compone de bloques de construcción más pequeños de su negocio desde una postura funcional. Identificar esto y definir el espacio de problemas de su API ayuda a proporcionar un enfoque más enfocado para conceptualizar el propósito exacto de su API y cómo se relaciona con su negocio existente.

Paso 2: Comprenda la audiencia de su API

Es fácil usar la palabra "desarrollador". Lo que es importante comprender es qué resultado está tratando de lograr el desarrollador final y en qué dominio se encuentran. Puede haber dos consumidores para sus API:

  • Consumidores en su vertical directo : este tipo de consumidor de API crea servicios que benefician directamente al consumidor principal de su producto principal.

Por ejemplo, los usuarios finales de Slack son personas dentro de una empresa que intentan comunicarse mejor entre sí. Para facilitar mejor la colaboración y la comunicación, la API de Slack puede integrarse fácilmente con muchas herramientas populares de terceros que utilizan las empresas y centralizar las notificaciones recibidas de estas herramientas. De esta manera, la API de Slack puede beneficiar directamente a las mismas personas que usan sus herramientas y generar un mayor compromiso y valor.

  • Consumidores en verticales tangenciales : este tipo de consumidor de API crearía servicios que pueden no necesariamente ayudar al consumidor directo del producto, pero resuelven la necesidad de otra vertical.

Por ejemplo, las empresas de viajes compartidos como Uber podrían integrarse con la API de Yelp para dar sugerencias de buenos restaurantes según la ubicación por la que conduzcan sus pasajeros. Este es un ejemplo clásico en el que la API de Yelp está beneficiando a los consumidores de Uber, una empresa que no necesariamente puede considerarse consumidor directo de Yelp. En general, esto le permite tener la visión de toda la cadena de valor de su API, compuesta por los consumidores directos e indirectos de su API.

Paso 3: alinee su equipo

Un programa de API escalable y exitoso primero necesita un equipo sólido detrás de él que sea plenamente consciente de los objetivos y el propósito de la API. Un gran equipo comienza con la alineación . La creencia de que las API son productos, que resuelven problemas y que tienen clientes que se preocupan por la calidad, es una mentalidad que debe inculcarse entre todos sus equipos. Una cultura de transformación digital implica la plena aceptación del poder de las API para ser la base de una plataforma exitosa.

La alineación puede llegar cuando articula claramente el estado actual y futuro de sus API y cómo se relacionan con toda su estrategia comercial. Después de esto, averigüe cómo unir todos sus equipos de desarrollo, operaciones y marketing a través de procesos bien definidos.

La forma en que elige a las personas adecuadas y define los procesos que los mantienen intactos a ellos y a su flujo de trabajo puede ser un factor determinante en el éxito de sus programas API. También debe implementar herramientas que admitan un enfoque colaborativo para el desarrollo de API .

Para obtener más información, lea: Al hablar de API, piense primero en la cultura

Paso 4: Desarrolle su API de forma incremental

Tener un enfoque impulsado por el producto implica crear API que brinden un valor inmenso a sus consumidores. Una táctica probada para ofrecer API que a la gente le encanta es la filosofía de construir, medir y aprender. Esto se toma directamente de la metodología Lean Startup de tener un conjunto de suposiciones sobre la validez de su oferta y probar y refutar iterativamente estas suposiciones. Las API se crean de forma incremental, con comentarios regulares de las partes interesadas y los clientes en cada iteración, para finalmente ofrecer una gran API.

Podemos dividir el desarrollo en todas sus fases individuales del ciclo de vida. Cabe señalar que todas estas fases deben estar respaldadas por una buena infraestructura de herramientas que se alinee con la cultura, las metodologías y las prácticas de su empresa. Herramientas como SwaggerHub , Apiary y Reprezen pueden ayudar a los equipos de desarrollo a diseñar y crear API en un entorno colaborativo.

Diseñando la API

Al final del día, su API es solo un contrato entre un servidor y un cliente, con el ciclo de solicitud-respuesta actuando como los términos del contacto. Si sus consumidores finales son los que encuentran valor en su API, este contrato debe diseñarse teniendo en cuenta sus necesidades. Diseñar una API significa proporcionar una interfaz eficaz que ayude a las partes interesadas internas a alinearse con los ciclos de solicitud y respuesta de la API y a que los consumidores externos comprendan, usen e integren mejor la API.

El diseño es el paso antes de desarrollar sus artefactos tecnológicos y lógica empresarial. El diseño de la API actúa como la función de fuerza para poner realmente los objetivos de la API y la focalización de personas en un documento legible por humanos y máquinas para que lo consuman sus ejecutivos y equipos técnicos. Como técnica de gestión de productos , esta es una manera fácil de enfocarse también en el consumidor, diseñando una experiencia que se adapte al tipo de audiencia hacia la que se comercializa su API.

En el ecosistema REST, la especificación OpenAPI (OAS) se ha convertido en el estándar mundial para diseñar la interfaz. La OAS es una especificación legible por humanos y máquinas que es independiente del lenguaje. Actualmente se encuentra en su tercera versión , con ricas capacidades expresivas para nuevas definiciones de seguridad, devoluciones de llamada, vinculación y más. La definición de la API en la OEA también abre un mundo de posibilidades en forma de burlarse, generar stubs de servidor, SDK, casos de prueba y más.

Para obtener más información, visite nuestra página API Design Insights

Virtualización de las dependencias de la API

Su API está diseñada para la interoperabilidad. A medida que las aplicaciones se vuelven cada vez más complejas con muchas dependencias y componentes, tanto internos como externos, se vuelve un desafío navegar por todas estas dependencias. Aquí es donde entra en juego la virtualización de API. La virtualización de API es el proceso de crear una copia virtual llamada de sus dependencias y refleja las especificaciones de su API deseada. Al crear un back-end virtualizado a partir de su diseño de API, además de burlarse de sus dependencias, puede:

  • Permita que sus equipos de frontend y backend trabajen en paralelo
  • Cree una API simulada con datos ficticios y distribúyala a algunas partes interesadas, tanto internas como externas, y obtenga esa retroalimentación temprana y entregue la excelencia de la API

La virtualización de API y las simulaciones se están poniendo de moda rápidamente debido a sus muchas ventajas. Este artículo puede ayudarlo a comprender mejor el concepto y los beneficios de la virtualización de API.

Construyendo la lógica empresarial de la API

Esta es la fase en la que toma su máquina y la capa de diseño de API legible por humanos y la convierte en código real y lógica comercial. Elegir el marco tecnológico adecuado es realmente importante en esta fase y, afortunadamente, abren la capa de diseño de API, ya que son independientes del idioma y pueden permitir que diferentes desarrolladores en equipos hagan lógica de negocios de API en diferentes idiomas. Por supuesto, hay muchas formas diferentes de elegir los lenguajes de programación adecuados, así que aquí hay un artículo que puede ayudar. Herramientas como el proyecto Swagger Codegen le permiten crear prototipos de API más rápidamente en el lenguaje de programación de su elección mediante la generación automática de código repetitivo a partir de su diseño de API. El generador de código se encarga de todo el andamiaje en el código de la API, por lo que su desarrollo parece centrarse en lo que realmente importa: la lógica empresarial de las API.

Probando la API

La fase de prueba está destinada a revelar errores, inconsistencias o cualquier tipo de desviación del comportamiento esperado de la API. Dependiendo de la importancia de la misión de sus API, puede realizar diferentes tipos de pruebas para asegurarse de que funcionen según lo previsto. Hay muchos tipos diferentes de pruebas que puede realizar, como pruebas funcionales, pruebas de confiabilidad, pruebas de carga y pruebas de seguridad, todas las cuales pueden priorizarse en función de los objetivos de su API y el público objetivo.

Creación de documentación de API

La documentación de su API es la cara de su API. Piense en ello como una entrega de contenido técnico que contiene instrucciones sobre cómo utilizar e integrar eficazmente su API. Es un manual de referencia conciso con toda la información necesaria para trabajar con la API, respaldado por tutoriales y ejemplos.

Los desarrolladores pueden generar automáticamente documentación desde la capa de definición de OpenAPI a través de varias herramientas de documentación de API . La documentación tiene un impacto directo en la adopción y el crecimiento de sus API. El nivel de sofisticación de su documentación puede variar según el caso de uso de las API. Si se trata de API internas, tal vez solo la documentación de referencia sea suficiente. Las API externas tienden a requerir mayores niveles de inversión, con SDK, tutoriales y una guía de introducción.

Paso 5: definir los KPI

Un indicador clave de rendimiento (KPI) es un valor medible que demuestra la eficacia con la que su API está logrando sus objetivos comerciales. Mientras se desarrolla su API, es valioso comprender exactamente cuáles son algunas medidas cuantificables del éxito de su programa de API. Es fácil perderse en un mar de KPI potenciales con los que puede medirse, por lo que vincular sus resultados medibles con el propósito y la audiencia de su API, definidos en los pasos 1 y 2, puede ayudar. Hay dos tipos de métricas con las que debe medirse.

Métricas del recorrido de la audiencia

Esto se caracteriza por medir los distintos pasos que necesita su usuario final para alcanzar y consumir su API. Este es un ejemplo clásico de KPI para un modelo de API tradicional.

EtapaAcción del consumidorKPI
Interés por usar APIRegistrarse para la clave APIEs hora de registrarse y obtener la clave
Deseo de usar APIEntender cómo usar la APITiempo hasta las primeras 200 respuestas de la API
Deseo de usar APIIntegración con APINúmero de llamadas a la API realizadas a lo largo del tiempo
Abogando por la APICompartir API entre círculos sociales y profesionalesNúmero de acciones realizadas a lo largo del tiempo

La importancia de medirse con métricas cuantificables podría disminuir al crear una API privada , lo que puede no requerir necesariamente la misma cantidad de rigor. Dicho esto, en el caso de las API privadas, los comentarios cualitativos y las anécdotas pueden servir como buenos criterios para medir la API también.

Métricas de objetivos comerciales

Estas métricas están más relacionadas con el propósito de su API. Si se trata de un modelo de API público o basado en socios, los precios y el crecimiento son buenos indicadores del éxito de su API. Si su API es para uso interno privado, entonces la cantidad de aplicaciones y procesos que se integran con la API es una buena medida de éxito. A continuación, se muestran algunos ejemplos de KPI centrados en el negocio.

Objetivo comercial de APIKPIEjemplo
Monetización directaAumento de MRRTwilio
Monetización indirectaNuevos clientes referidos a través de APIeBay
Monetización de paquetesValor de por vida del cliente de los clientes que utilizan aplicaciones creadas a través de APIFuerza de ventas

Paso 6: recopilar comentarios y actuar sobre ellos

Las métricas que defina anteriormente pueden ayudarlo a establecer puntos de referencia al recopilar comentarios sobre la calidad y el valor comercial de su API. Una vez que haya terminado con las fases anteriores, entregue las API en un portal básico para permitir el consumo por parte de las partes interesadas adecuadas y obtenga comentarios. Este paso se trata de obtener comentarios valiosos de un tamaño de muestra inicial de usuarios potenciales. Este paso consta de dos partes:

  1. Identificar a los primeros usuarios que puedan proporcionarle comentarios. Puede aprovechar las relaciones con algunos de sus clientes existentes o buscar a los primeros usuarios en los canales donde suelen pasar el rato. Este artículo de Lean Startup puede ser beneficioso para comprender cómo obtener usuarios pioneros
  2. Recopilar y consolidar los comentarios e iterar sobre ellos.

Esta retroalimentación debe procesarse y actuarse rápidamente, como parte de la filosofía de construir, medir y aprender. Los nuevos comentarios se incorporan nuevamente en el proceso de diseño y desarrollo de API, lanzando nuevas actualizaciones constantemente.

También: Preguntas para ayudar a acumular comentarios de los desarrolladores

Paso 7: Comercialización de la API

Comercializar su API consiste en educar a sus consumidores sobre sus beneficios y defender por qué puede ser una parte integral de la cadena de herramientas del desarrollador. Al final del día, desea asegurarse de que sus API se descubran y consuman, tanto interna como externamente. En general, el marketing es una combinación de contenido entrante, que incluye (incluye mensajería entrante y documentación) y evangelismo saliente. Este libro electrónico de la API nórdica explica en detalle las distintas etapas para crear un programa de marketing exitoso en torno a su API, incluidas varias etapas como establecer y mantener relaciones con los desarrolladores, crear tutoriales y crear un programa de promoción en torno a sus API.

Notas de cierre

La creación de API con el consumidor final en mente es la base del pensamiento del producto. El pensamiento basado en el producto trata de encontrar un equilibrio entre los consumidores finales, las empresas y la tecnología, mientras construye gradualmente una solución que proporciona un valor real y sostenible.

Publicar un comentario

0 Comentarios