Header Ads Widget

Ticker

6/recent/ticker-posts

¿Qué es un portal API?

 

Si bien la mayoría de las organizaciones han madurado en el desarrollo de la unión entre sus sistemas de información y aplicaciones a través de API, muchas a menudo pasan por alto cómo entregar y exponer esas API a sus respectivos consumidores.

La reutilización y la adopción son los factores que impulsan un ROI saludable de una API, pero son más difíciles de obtener de lo que cree. A menudo, esto se debe a que el proveedor sufre de falta de visibilidad del catálogo de API, documentación deficiente y / o instalaciones de autoservicio deficientes para los consumidores de API.

Se requiere mucho trabajo para incorporar nuevos usuarios de API. Los consumidores desarrolladores primero deben descubrir la API y luego evaluar si proporciona los servicios que buscan. La API debe ser de alta calidad, estable y comparable o mejor que servicios similares en el mercado antes de que reconozcan que vale la pena invertir tiempo y dinero.

Un portal de API tiene como objetivo agilizar este proceso. Como su nombre indica, un portal de API cierra la brecha entre los consumidores de API y los proveedores de API . En este artículo, veremos qué debe abarcar un portal de API y cómo puede ayudar a los proveedores de API a cerrar la brecha de reutilización y adopción para proporcionar una plataforma para promover con éxito sus API.

Terminologias

Antes de comenzar, aclaremos algunas terminologías. Estos son los principales actores involucrados cuando discutimos los beneficios de los portales API:

  • Proveedor de API : API de organización, departamento o creación de equipos para consumo interno o externo.
  • Consumidor de API : los consumidores de desarrolladores que utilizan la API. Incluso puede ser un departamento diferente dentro de la organización proveedora.
  • API públicas : API que están disponibles para el público en general para su visualización y suscripción, ya sea con cargo o abiertas de forma gratuita.
  • API de socios : API que están disponibles para socios estratégicos y confiables.
  • API internas : API que están disponibles para uso interno solo dentro de la organización del proveedor de API.

Promoción: 6 características de un portal API de calidad

Como cualquier otro tipo de producto, una API requiere una estrategia de marketing eficaz Esto surge en forma de un portal API para respaldar algunas actividades promocionales clave Independientemente de que su API sea pública, asociada o privada, el contenido debe ser rico e informativo. A menudo respaldado por un propietario de producto de API, un evangelista de API , desarrolladores internos y redactores de contenido, un portal para desarrolladores se compone de las siguientes seis unidades principales.

1: Catálogo

Un catálogo de API describe qué API están disponibles para el consumo, enumerándolas todas y proporcionando descripciones amplias para cada método. La documentación también debe proporcionar el mecanismo de autenticación y autorización, casos de uso que describen contextos comerciales potenciales e implementaciones en vivo del mundo real cuando sea posible.

2: Información del ciclo de vida

Un portal de API también debe describir la información del ciclo de vida de la API , identificando claramente:

  • Política de desactivación : cuándo y en qué circunstancias se retiraría la API .
  • Horarios de lanzamiento : Frecuencia de lanzamientos mayores y menores.
  • Procesos de migración : formas de migrar entre diferentes versiones de API para un consumidor existente.
  • Metodología de control de versiones : ¿Cuál es el método de control de versiones específico Por ejemplo, las versiones secundarias pueden ser compatibles con versiones anteriores, mientras que las versiones principales pueden requerir modificaciones de código para las aplicaciones consumidoras.
  • Últimos resultados de las pruebas : siempre que sea posible, los proveedores de API también deben compartir los resultados actualizados de las pruebas funcionales.

3: Legal

Su portal para desarrolladores también debe cubrir territorio legal . Para asegurarse de comunicar los medios y procesos para consumir las API , describa los criterios de elegibilidad. Estos son los términos y condiciones para calificar para ser consumidor de API. Por ejemplo, acceder a su servicio puede ser tan simple como crear una cuenta de usuario y recibir claves API . O puede haber un proceso de aprobación complejo que involucre a equipos legales. Cualquiera que sea su proceso específico, articúlelo claramente y use diagramas visuales cuando sea apropiado.

4: Información de precios

Si las API no son de uso gratuito, debe describir el costo monetario involucrado a nivel de API individual, así como para las API empaquetadas. Describe los modelos de precios complejos que puedan existir. Por ejemplo, puede ser que el consumidor pague por adelantado por un uso limitado, se le cobre por llamada o recurso, o pague una tarifa fija por uso ilimitado. Algunos programas agrupan la API en paquetes más grandes, ofreciendo tarifas más rentables al hacerlo, o proporcionan lucrativas ofertas con descuento durante todo el ciclo de vida de la API. El Acuerdo de nivel de servicio y las implicaciones de las infracciones de SLA también deben acompañar a la información de precios.

En ocasiones, puede resultar demasiado engorroso administrar la información de precios como contenido del portal para desarrolladores; más bien, algunos grupos prefieren que el portal API esté integrado con un catálogo de productos separado que se especialice en la oferta de productos y la gestión de precios.

5: Recursos de formación

Agregue materiales de capacitación como tutoriales y procedimientos a su portal para desarrolladores. El material de incorporación no tiene que limitarse al texto; considere los videos de capacitación y otro contenido multimedia enriquecido También es útil proporcionar una zona de pruebas de API para que los consumidores potenciales puedan realizar solicitudes de muestra y ver respuestas. Asegúrese de que sus recursos de capacitación cubran aspectos como:

  • Demuestre cómo se proporcionan los tokens de seguridad
  • Requisitos previos que deben cumplirse antes de la invocación de la API
  • Ejemplo de solicitud y respuesta para invocaciones de API
  • Escenarios de error y cómo los manejará la API
  • Kits de desarrollo de software y bibliotecas para impulsar el consumo de API.

6: API Health Insights

Para aumentar la confianza del consumidor, un proveedor debe hacer que el rendimiento de su API sea transparente. Escuchar el latido de la API con monitoreo en tiempo real , el uso actual de la API, la cantidad de suscriptores, el tiempo de respuesta promedio y otros conocimientos puede actuar como un gran impulso de confianza. El portal también debe proporcionar una lista detallada de problemas y plazos de resolución esperados; Aquí es beneficioso permitir que los consumidores voten para ayudar a priorizar los problemas.

Lea también: Hermoso diseño de interfaz de usuario para portales de desarrolladores de API

Adopción de API: incorporación de nuevos usuarios

Una vez publicitados, los proveedores de API deben centrarse igualmente en la adopción de API , porque en ausencia de un servicio al cliente consistente y de calidad, el uso se desplomará. A continuación se muestra una lista de elementos en los que los proveedores de API deben concentrarse para mejorar la experiencia de incorporación del desarrollador; recuerde, proporcionar tantas opciones de autoservicio como sea posible le facilitará la vida.

Acciones de incorporación de desarrolladores

El portal de API debe ser el canal principal para la incorporación de consumidores de API. Esto puede involucrar diferentes procesos según el tipo de API; por ejemplo, puede ser tan simple como registrarse usando inicios de sesión sociales, o puede involucrar un proceso de creación de cuenta más complejo que involucra una jerarquía de aprobación y actualizaciones del sistema.

En cualquier caso, el portal de la API debe proporcionar o integrarse con un sistema de flujo de trabajo que se pueda utilizar para implementar diferentes procesos para la incorporación de consumidores. Desde el punto de vista del proveedor , es posible que deban tomarse las siguientes acciones durante el proceso de incorporación del consumidor. Es posible que algunos deban realizarse manualmente, mientras que otros deben realizarse automáticamente:

  • Aprobar / rechazar el registro de usuario
  • Sugerir una modificación a la información de registro del usuario, como cambiar el código de la organización
  • Validar la información proporcionada durante el registro de usuario
  • Enviar invitaciones de registro de usuario
  • Asignar un administrador de la comunidad a la organización
  • Creación y aplicación de diferentes niveles de cuenta para diferentes roles del portal de desarrolladores, como moderador o administrador.
  • Envíe notificaciones, como garantías de marketing o actualizaciones de mantenimiento.
  • O defina otros flujos de trabajo personalizados para el proceso de aplicación del consumidor de API.

Desde la perspectiva del consumidor , sus necesidades durante la incorporación son un poco diferentes. Estas son algunas de las funciones de autoservicio que un consumidor de API necesitará realizar en el portal:

  • Regístrese en la API con (o sin) una cuenta social
  • Inicie sesión en el portal, una vez registrado
  • Restablecer las credenciales de inicio de sesión y actualizar la información de la cuenta
  • Ver una página de destino personalizada
  • Registre su (s) aplicación (es)
  • Genere credenciales como claves API
  • Interactuar con la documentación de la API
  • Pruebe las funcionalidades de la API, vea ejemplos de llamadas / respuestas
  • Invite a otros desarrolladores de aplicaciones a colaborar.
Relacionado: 3 formas de organizar sus documentos de desarrollador de API

Incorporación de varios tipos de consumidores

Los anteriores son casos de uso muy genéricos que pueden no ser aplicables a todos los tipos de escenarios de consumo de API. Para comprender las necesidades específicas basadas en diversas bases de consumidores objetivo, veamos cómo cambia la incorporación para usuarios públicos , socios y usuarios privados .

1. Usuario público

Con los usuarios públicos, la incorporación del consumidor se puede realizar mediante inicios de sesión sociales o mediante un registro directo con el proveedor. A menudo, en el ámbito público, el proveedor ofrece un modelo de uso de freemium . Al hacerlo, es extremadamente importante que se apliquen las cuotas, para que los proveedores puedan monetizar sus servicios correctamente.

Si se supone que las API deben ser utilizadas solo por ciertos dominios web, entonces también debería haber implementaciones sobre el intercambio de recursos de origen cruzado . Los proveedores públicos deben tener una seguridad sólida, aceptando tokens de seguridad como claves API durante la invocación de la API para su identificación. El portal de API debe permitir a los usuarios generar estas claves de API y, opcionalmente, solicita a los usuarios que proporcionen detalles de la aplicación junto con los nombres de dominio desde los que se consumirán las API.

A continuación, se muestran algunos escenarios de API públicas específicas para diferentes sectores industriales en los que tener un portal para desarrolladores es clave:

  • Atención médica : las API que proporcionan datos sobre instalaciones médicas, profesionales médicos, detalles farmacéuticos o estadísticas pueden ser gratuitas o de pago, según el proveedor. Como las API brindan información en lugar de funcionalidad, estas API a menudo no requieren un espacio aislado y la aplicación del usuario final se puede integrar directamente con las API de producción.
  • Banca : API que proporcionan información bancaria para ayudar a mejorar la experiencia del cliente. Algunos ejemplos son las API para proporcionar ubicaciones de sucursales, tasas de interés, ofertas de productos y tasas de cambio. Como la información está disponible públicamente y es de solo lectura, no es necesario un entorno de pruebas. Las API de producción pueden estar disponibles directamente a través de un portal de API. Es necesario que exista control y aplicación de cuotas para gestionar las oleadas de tráfico.
  • Telecomunicaciones : API para proporcionar información disponible públicamente como ofertas de planes, detalles de precios, detalles de teléfonos móviles, filtros de correo no deseado, ubicación geográfica, análisis, servicio de recarga, servicios de contenido u otros. Un ejemplo de caso de uso es una aplicación para ayudar al usuario a encontrar las mejores ofertas.

Algunos de estos tipos de API, como una API de servicio de recarga, requerirán un entorno de espacio aislado . Mediante un portal de API, los proveedores pueden proporcionar acceso de usuario a entornos de producción y sandbox, que utilizan diferentes puntos finales. En este escenario, es mejor mantener claves API separadas para entornos sandbox y de producción para evitar confusiones.

Relacionado: 7 ingredientes que conforman un excelente centro de desarrollo

2. Socios

Con las integraciones de socios, la incorporación del consumidor no es tan sencilla. El consumidor de API debe ser un socio confiable y, por lo tanto, debe tener un acuerdo para usar las API para cumplir con un objetivo comercial común. En este escenario, el consumo de API puede ocurrir a través de un canal de comunicación dedicado, como una red privada virtual, o a través de canales públicos como Internet.

Una organización con un proceso de incorporación maduro para socios tendrá flujos de trabajo automatizados con un portal de API como punto de partida del proceso de aprobación. Dado que el cumplimiento del flujo de trabajo puede tardar días o semanas en completarse, el portal de la API debe proporcionar actualizaciones de estado sobre el progreso de la incorporación.

Para una integración de socio de ejemplo, tome las API de pago que facilitan las transacciones para los clientes bancarios. A medida que las instituciones financieras abren sus pasarelas de pago a través de API, a menudo se ponen a disposición de las instituciones financieras asociadas seleccionadas cuando las necesitan. Ofrecer a las empresas y consumidores un sistema de pagos rápido, versátil y rico en datos para realizar pagos diarios requiere que las instituciones financieras proporcionen una infraestructura a través de la cual los consumidores puedan integrarse fácilmente.

En este intercambio, un desafío importante es asegurar la invocación de API a través de un canal público, así como ocuparse de los requisitos de no repudio . Estos entornos requieren un entorno de pruebas para permitir el ejercicio de integración entre las instituciones. En entornos de socios, un portal de API debe facilitar las siguientes acciones únicas para respaldar la incorporación de socios:

  • Gestionar el registro de consumidores de API solo mediante invitación
  • Personalice el catálogo de API para socios invitados
  • Permitir al socio cargar / modificar de forma segura sus certificados públicos u otras credenciales de seguridad para usar durante la invocación de la API.
  • Hacer cumplir procesos de registro de usuarios más estrictos.

3. Usuarios privados

Dado que las API privadas son internas de las organizaciones, tiene sentido extender el portal de API en todos los entornos de producción y no producción. A los desarrolladores y arquitectos les gusta ver las API en todos los entornos y también ver cómo se están rastreando sus API dentro del proceso de desarrollo.

Como habrá algunas API abiertas para la integración con todas las aplicaciones, y algunas API de alto valor accesibles solo para ciertas aplicaciones, los portales de desarrolladores privados a menudo requieren una combinación de estilos de incorporación públicos y de socios. El portal de API debería poder diferenciar entre estas diversas API internas y diferentes flujos de trabajo para los usuarios.

Gestión de suscripciones

Los usuarios de un portal API deben poder administrar su suscripción independientemente de que la suscripción sea de pago o gratuita. El portal de API también debería permitir a los usuarios monitorear el uso de API en su nivel de organización y de aplicación, y actualizar o degradar su plan de suscripción. Si el uso de la API se paga, entonces debe proporcionar a los usuarios una posibilidad para verificar y generar facturas, así como realizar pagos de facturas.

Como gerente de producto de API, algunos de los casos de uso genéricos con respecto a la administración de suscripciones serían:

  • Definir plan de suscripción para el consumo de API
  • Definir canales de pago
  • Enviar material publicitario específico de la suscripción a la API
  • Enviar notificación relacionada con las suscripciones de API

Como desarrollador de aplicaciones, algunas acciones necesarias serían:

  • Ser capaz de proporcionar aplicaciones (desde aplicaciones registradas) que consumirían las API suscritas
  • Solicite un presupuesto personalizado para una suscripción a la API
  • Monitorear y rastrear el uso de API
  • Realizar pago y generar facturas

Comunidad y foros

Un portal de API de calidad también permite a los usuarios compartir su experiencia de uso de API y hacer sugerencias para mejorar las API. Los moderadores deben poder crear foros, invitar usuarios y mediar en la discusión del foro. Los foros también pueden ser una forma para que la organización del proveedor alerte y notifique a los consumidores de API sobre cualquier cambio o actualización.

Conclusión

El portal para desarrolladores es verdaderamente la intersección entre el proveedor de API y el consumidor desarrollador. Al abordar las necesidades específicas tanto del proveedor de API como del consumidor de API, podemos desarrollar portales de API útiles que mejoran la experiencia de incorporación.

En términos de implementación de una solución de portal API, es difícil encontrar productos de terceros que cumplan todos los requisitos, pero al mismo tiempo, las soluciones propias pueden no ser ideales: la falta de integración con las puertas de enlace API subyacentes y el alto costo de construir un El sistema de gestión de contenido desde cero podría ser un gran impedimento.

Al elegir una herramienta para usar, los proveedores de API deben buscar un equilibrio seleccionando productos listos para usar que brinden una buena integración con las plataformas API subyacentes, pero que al mismo tiempo sean flexibles con los flujos de trabajo de registro específicos, los sistemas de identidad y los catálogos de productos que son exclusivos de su tipo de API.

Publicar un comentario

0 Comentarios