Tutorial: Cómo monetizar un producto API

Antes de empezar

Acerca de esta guía de aprendizaje

IBM® API Connect incluye una función de facturación de suscripciones que permite a los proveedores de API definir planes de precios en sus productos API y monetizar sus ofertas de API. Si un Producto contiene un Plan de precios, los consumidores de API deben introducir su información de pago en el Portal para desarrolladores antes de poder suscribirse a ese Plan. API Connect admite la integración con Stripe Subscription Billing, un servicio en la nube independiente que gestiona los planes de productos monetizados, los clientes, su información de pago y su historial de suscripción, con el fin de generar facturas mensuales y cobrar a los clientes automáticamente. Con esta integración, Stripe actúa como el sistema de facturación de suscripción y, también, el sistema de procesamiento de pagos.

Configure su recurso de facturación

Cree un recurso de integración de facturación Stripe para su organización proveedora completando los siguientes pasos.

1. Inicie sesión en API Manager.
2. En la página de inicio, haga clic en el mosaico Gestionar recursos.
   
3. En la página Recursos, realice las siguientes tareas.
   1. En el panel izquierdo, seleccione Facturación.
   2. En el panel derecho, haga clic en Añadir.
      

      Se muestra la página Añadir integración de facturación para la integración de Stripe.

4. En la página Añadir integración de facturación, realice las siguientes tareas.
   1. En el campo Título, introduzca el título de su integración de facturación. Por ejemplo, My Stripe Billing.
      Nota: El campo Nombre se rellena automáticamente en función del Título introducido.
   2. En el campo Clave publicable, introduzca la clave de prueba de su cuenta de Stripe.
   3. En el campo Clave secreta, introduzca la clave de prueba de su cuenta de Stripe.
      Consejo: Si no tiene una cuenta de Stripe, puede crear una aquí: https://dashboard.stripe.com/register. Consulte su panel de Stripe para obtener sus claves API de prueba. Para más información, consulte https://dashboard.stripe.com/apikeys.
      Nota : Cada cuenta Stripe viene con dos conjuntos de claves API, uno para pruebas y otro para producción. Cada conjunto de claves API tiene un espacio de nombres distinto para los objetos de Stripe. Las claves API de prueba no pueden ver los objetos creados por las claves API de producción, y viceversa. No puede cambiar las claves API de una de sus integraciones de facturación por las claves de otra cuenta, ni intercambiar sus claves de prueba y producción, ya que eso impediría que API Connect resolviera los objetos de Stripe que se crearon utilizando las claves antiguas. Para este tutorial, debe utilizar sus claves API de prueba de Stripe.
   
5. Haga clic en Añadir para crear su recurso de integración de facturación de Stripe. La integración de My Stripe Billing se muestra ahora como el recurso de facturación.
   

Configurar un catálogo de prueba de banda

Para poder publicar Planes de Producto monetizados, debe añadir su recurso de integración de facturación a un catálogo. Durante esta actividad, creará un nuevo catálogo llamado stripe-test, por lo que puede eliminar el catálogo al final del tutorial si lo desea.

1. En el Gestor de API, haga clic en el icono Manage de la barra de navegación lateral.
2. Haga clic en Añadir > Crear catálogo y cree un nuevo catálogo llamado stripe-test.
3. Haga clic en el mosaico del catálogo de prueba de bandas y, a continuación, haga clic en la pesta ña Configuración del catálogo. Seleccione los servicios de puerta de enlace y asegúrese de que el catálogo está configurado para utilizar un DataPower® Gateway (v5 compatible) o un DataPower API Gateway, o ambos. A continuación, seleccione Portal y cree un Portal para desarrolladores. Si no está seguro de cómo configurar estas opciones, consulte Creación y configuración de catálogos.
4. Para añadir el recurso de integración de facturación al catálogo, seleccione Facturación y, a continuación, haga clic en Editar.
   
5. Seleccione el recurso de facturación My Stripe que creó anteriormente y haga clic en Guardar.
   
   Mi facturación de Stripe ahora aparece como el recurso de integración de facturación para el catálogo de prueba de Stripe.
   

Habilitar el método de pago Stripe en el Portal para desarrolladores

Para permitir que los consumidores de API se suscriban a productos con planes de pago, debe configurar el método de pago Stripe en el portal para desarrolladores para el catálogo de prueba de Stripe.

1. Inicie sesión en el Portal para desarrolladores como administrador.
2. Si el panel de control del administrador no aparece pulse Gestionar para visualizarlo.
3. En el panel de control del administrador, haga clic en Extender. Se abre la pestaña Lista de la página Extender y se muestra la lista de módulos instalados.
4. Introduzca Stripe en el filtro de búsqueda, seleccione Integración de Stripe con monetización de APIC y haga clic en Activar.
   
   La configuración predeterminada del módulo APIC Monetization Stripe Integration ya está activada, y ahora debe editar esa configuración.
5. Haga clic en Configuración > Sistema > IBM API Connect Facturación.
6. Cambie la opción desplegable de asignación de módulos del proveedor de facturación para que sea la integración de Stripe de monetización de APIC (ibm_stripe_payment_method ) recién habilitada, y haga clic en Guardar configuración.
   
7. Haga clic en Configuración > Sistema > IBM APIC Stripe Integration, e introduzca las mismas credenciales API de prueba de Stripe que introdujo para el recurso de integración Mi facturación de Stripe en el paso 4 de Configurar su recurso de facturación. A continuación, haga clic en Guardar configuración.
   
   El método de pago Stripe ya está configurado en el Portal para desarrolladores.

Crear y publicar un Producto monetizado

Crear un producto que incluya un plan de precios y publicarlo en el Portal para desarrolladores.

1. Primero debe descargar una API de prueba para usar con su Producto:
   • Si su catálogo de prueba de banda utiliza un archivo de prueba de banda ( DataPower Gateway (v5 compatible) ), descargue el findbranch.txt archivo a su sistema de archivos local. Cambie el nombre de este archivo a findbranch.yaml.
   • Si su catálogo de prueba de bandas utiliza un archivo de prueba de bandas ( DataPower API Gateway ), descargue el findbranch_v6.txt archivo a su sistema de archivos local. Cambie el nombre de este archivo a findbranch.yaml.
   O si lo prefiere, puede utilizar una de sus propias API.
2. Para importar la API en API Manager, haga clic en el icono Develop de la barra de navegación lateral y, a continuación, haga clic en Add > API (de REST, GraphQL o SOAP).
   
3. Asegúrese de que OpenAPI 2.0 está seleccionado, y luego seleccione Archivos de configuración existentes ( OpenAPI ) en la sección Importar (Import ), y haga clic en Siguiente (Next ).
   
4. Haga clic en Arrastrar y soltar archivos aquí o haga clic para cargar, y seleccione el archivo findbranch.yaml en su sistema de archivos local para cargarlo. A continuación, pulse Siguiente.
   
5. Deje sin marcar Activar API, ya que activará la API cuando publique el Producto monetizado más adelante en esta sección. Pulsar Siguiente para continuar.
6. Aparece la página de resumen, que muestra que se ha generado la definición de la API.
   
7. Haga clic en Editar API para ver la definición de API generada y, a continuación, haga clic en el icono Desarrollar de la barra de navegación lateral para continuar con la creación de un Producto monetizado. La API FindBranch API debería aparecer ahora en su lista de APIs - si no es así, simplemente haga clic en el icono Refresh para actualizar su navegador.
8. Haga clic en Añadir > Producto
   
9. Seleccione Nuevo producto y haga clic en Siguiente.
10. Introduzca FindBranches en el campo Título y haga clic en Siguiente.
    
11. Seleccione la API de FindBranch que importó, o su propia API, y haga clic en Siguiente.
12. Acepte los valores predeterminados para los Planes y haga clic en Siguiente. Añadirás un Plan con precio más adelante.
    
13. Acepte también los valores predeterminados para Publicar, Visibilidad y Suscribibilidad, y haga clic en Siguiente.
    
14. Aparece la página de resumen, que confirma que se ha creado el nuevo producto.
    
15. Haga clic en Editar producto para continuar con la configuración.
16. Con la pestaña Diseño seleccionada, haga clic en Planes en el menú de navegación.
    
17. En la sección Integración de facturación, seleccione my-stripe-billing como recurso de integración de facturación.
18. En la sección Planes, haga clic en Añadir para crear un nuevo Plan con precios.
19. Introduzca un título para el nuevo plan, por ejemplo, « Gold », pero deje sin marcar la casilla de aprobación.
20. Cambie el conmutador a Activado para ver los precios del Plan, y se mostrará la sección de definición de precios del Plan.
21. Seleccione Incluir días de prueba gratuitos y deje el valor predeterminado de 1 para el número de días de prueba que un suscriptor puede utilizar el Plan sin cargo, después de lo cual comienza su ciclo de facturación.
22. De nuevo, deje los valores predeterminados de USD - US Dollar para la divisa y 10 para el precio mensual que se le cobrará al suscriptor.
    
23. En la sección de límites de tarifa del Plan, cambie las Llamadas a ser 1000 por hora, para diferenciar este Plan del Plan Predeterminado. Haga clic en Guardar para guardar el nuevo plan de precios.
    
24. Ahora puede publicar el Producto monetizado en el catálogo de stripe-test haciendo clic en el icono Opciones del Producto, y haciendo clic en Publicar.
    
25. Asegúrese de que el catálogo de prueba de rayas esté seleccionado y, a continuación, haga clic en Publicar.
26. Puede comprobar que el FindBranches Producto ya está publicado haciendo clic en el icono Manage de la barra de navegación lateral y seleccionando el mosaico stripe-test. El FindBranches El producto aparece ahora en la pestaña Productos.
    
    Consejo: Recuerde hacer clic en el icono Actualizar si no se muestra el Producto.

Verifique la publicación en su cuenta de Stripe

Puede verificar que los Planes de productos se publicaron en su cuenta de Stripe completando los siguientes pasos.

1. Inicie sesión en su cuenta de prueba de Stripe.
2. Seleccione Eventos en la navegación de Desarrollador.
3. Comprueba que se crearon eventos cuando publicaste los planes de producto.

Ver el producto monetizado en el Portal para desarrolladores

Puede comprobar que el Producto monetizado ya está visible en el Portal para desarrolladores siguiendo los pasos que se indican a continuación.

1. Abra el Portal para desarrolladores para el catálogo de pruebas de Stripe en su navegador web. No es necesario que inicie sesión.
2. Debería ver el FindBranches Producto en la página de inicio.
   
3. Haga clic en el FindBranches y se mostrarán los Planes, tanto el Plan Predeterminado como el Plan Gold. Puede ver la información de precios del Plan Gold y, si pasa el cursor por encima del texto 2 límites de tarifa, puede ver los detalles del límite de tarifa. Un consumidor de API ahora puede suscribirse a este plan monetizado.
   

Qué ha hecho en esta guía de aprendizaje

En este tutorial, ha creado y publicado correctamente un producto monetizado listo para suscripciones de consumidores API. Ha completado las siguientes actividades:

• Creación de un recurso de integración de facturación de Stripe.
• Configurado un catálogo de prueba de banda.
• Habilitado Stripe en el Portal para desarrolladores.
• Creó y publicó un Producto monetizado.
• Verificado la publicación en su cuenta de Stripe.
• Ha visto el Producto monetizado en el Portal para desarrolladores.