Blog

Guía rápida para el consumidor de APIs en Nubentos

por | 21 Oct 2019 | 0 Comentarios

por | Oct 21, 2019 | Guías | 0 Comentarios

¿Interesado en integrar algunas de nuestras API de salud digital en su software? ¿No sabe por dónde empezar, cómo hacerlo o qué pasos seguir? Este post es para ti (y para tu equipo de TI). Hemos preparado esta guía rápida para el consumidor de APIs en Nubentos pensando en ti, caminando en tus zapatos y reuniendo todo lo que nos gustaría encontrar si fuéramos tú.

Empecemos.

ENCUENTRA TUS APIs

Puedes acceder a nuestro catálogo de novedades de Salud Digital de forma gratuita navegando por nuestra API Store, disponible en nuestra web.


Puedes elegir entre dos vistas: la vista de APIs y la vista de Packs.

Guia Consumidor de APIs_API Consumer_2_Captura selector de vista

La vista de APIs es la cartera tradicional de APIs, donde puedes navegar API por API nuestro catálogo completo. La vista de Packs le permite navegar por nuestro mercado desde un enfoque orientado al negocio, Pack por Pack. Cada Pack contiene un conjunto de APIs, agrupadas por un criterio de negocio.

Guia Consumidor de APIs_API Consumer_3_Captura general vista packs-01

En la vista de las APIs, puedes utilizar cualquiera de las herramientas de filtrado que se muestran en nuestra barra fija, encima de las APIs.

Guia Consumidor de APIs_API Consumer_4_Captura barra de filtros_CON ETIQUETAS

A. CATEGORÍA. Aquí puede seleccionar entre el gran número de etiquetas que están asociadas a cada API o Pack.
B. ESTADO. Filtra las APIs en estado «PUBLISHED», «COMING SOON» o ambos.
C. MODELO DE PRECIOS. Aquí puedes filtrar las APIs que son GRATUITAS (todos sus planes de consumo son gratuitos), las que son FREEMIUM (con algún consumo gratuito y otro de pago), y las que son COMERCIALES (sin consumo gratuito).
D. CERTIFICACIÓN. Este filtro permite identificar rápidamente las APIs que tienen las certificaciones más importantes, como el Marcado CE o la Aprobación de la FDA.
D. BÚSQUEDA. En este campo puede escribir un texto y se filtrarán inmediatamente las APIs que lo contengan en su nombre o descripción.

Para cada API hay una página de detalles llena de información útil, que le ayudará a decidir si esa API es de su interés. Puedes acceder a ella haciendo clic en el botón «Ver API» de cualquier ficha de API.

Guia Consumidor de APIs_API Consumer_5_Captura ficha detalle CardioAPI_CON ETIQUETAS

A. Nombre de la API, logotipo y modelo de precios.
B. Etiquetas asociadas a la API, por las que se puede filtrar la cartera.
C. Descripción de la API.
D. Información sobre su versión, proveedor, estado, entornos disponibles, certificaciones, etc.
E. Documentación disponible publicada por el proveedor junto con la API.
F. Herramienta de estimación de costes.

Debajo de los detalles de la API, encontrarás un botón «Usar API«, que te llevará a la API en nuestra plataforma para desarrolladores, donde podrás usarla e integrarla en tu software.

Guia Consumidor de APIs_API Consumer_6_Captura boton Use API

Cuando hagas clic en ese botón, se te pedirá que te registres en caso de que aún no lo hayas hecho. Sólo los usuarios registrados con una membresía SaaS activa pueden acceder a la plataforma para desarrolladores de Nubentos.

 CONSEJOS E INFORMACIÓN

Cuando haga clic en una API etiquetada como «SOON«, no encontrará un botón «Usar API«. En su lugar, verá un formulario de suscripción. Puede utilizarlo para que le informemos por correo electrónico en cuanto esa API esté totalmente disponible, y así nos ayudará a traer más proveedores de esa solución.

El estado «SOON» («COMING SOON«) significa que la API ya está siendo publicada, en caso de que esté asociada a una API y un proveedor con nombre, y que estará totalmente disponible como API GRATUITA, FREEMIUM o DE PAGO en un futuro próximo.

Guia Consumidor de APIs_API Consumer_7_Captura ficha Dentomo

En caso de que no veas un nombre de API específico y su proveedor, significa que varios proveedores de este tipo de solución han sido identificados por nuestro equipo comercial, y estamos en conversaciones con ellos.

Guia Consumidor de APIs_API Consumer_8_Captura ficha AI4PulmonaryNodules

HERRAMIENTA DE ESTIMACIÓN DE COSTES

Una de las características más útiles disponibles para nuestros usuarios y visitantes, es la Herramienta de Estimación de Costes que encontrará en cada página de detalles de nuestras APIs.

Esta herramienta tiene como objetivo ayudarle a estimar los costes que tendrá que afrontar en caso de que elija esa API específica para sus proyectos.

Vamos a comprobarlo en detalle.

Guia Consumidor de APIs_API Consumer_10_Captura calculadora de costes por defecto_CON ETIQUETAS

A. Planes SaaS de Nubentos. Las columnas de esta tabla muestran nuestros Planes SaaS.
B. Planes de Consumo de API. Las filas de esta tabla muestran los diferentes Planes de Consumo disponibles para esa API.
C. Disponibilidad. Las celdas de esta tabla muestran qué Planes de Consumo están disponibles bajo qué Planes SaaS.
D. Volumen estimado. Aquí puede escribir el número estimado de llamadas mensuales a la API (usos de la API) para esta API aplicada a su caso de negocio y usuarios.
E. Botón «Calcular». Al hacer clic en él, las celdas de la tabla mostrarán los costes para cada par de plan SaaS y plan de Consumo.

Guia Consumidor de APIs_API Consumer_11_Captura calculadora de costes uso

El mejor par, es decir, el más barato, será resaltadoPuede comprobar los detalles de los costes calculados colocando el puntero del ratón en cualquier celda. Un tooltip mostrará los costes de SaaS y los costes de consumo.

El coste de SaaS es un coste fijo, unitario para su cuenta de usuario, y por lo tanto se aplica sólo una vez, independientemente del número de APIs que esté utilizando.

El coste de consumo es un coste variable, por cada API. Aquí puede ver el resultado de aplicar la tarifa del plan de Consumo (la fila) al número de llamadas a la API que ha introducido como volumen de uso mensual estimado.

REGÍSTRATE EN NUBENTOS

Aunque la navegación por nuestro catálogo es gratuita y pública, y puede visitar cualquier página de detalles de cualquier API o Pack, sólo los usuarios registrados con una membresía SaaS activa en Nubentos pueden acceder a nuestra plataforma de desarrolladores para utilizar las APIs.

El proceso de registro es un proceso de dos etapas. Primero, se crea la cuenta de usuario.

Guia Consumidor de APIs_API Consumer_12_Captura de alta de usuario

Segundo, y más importante, suscribes tu cuenta de usuario a uno de nuestros planes de SaaS disponibles.

Guia Consumidor de APIs_API Consumer_13_Captura planes de precios

Es muy importante que completes todo el proceso, ya que de lo contrario no tendrás acceso a nuestra plataforma para desarrolladores, y no podrás probar las APIs e integrarlas en tus proyectos.

SUSCRÍBETE A LAS APIs

Has accedido a la API en nuestra plataforma para desarrolladores a través del botón «Usar API» en su página de detalles.

¡Aquí es donde todo sucede! Vamos a comprobar esta plataforma y lo que puedes hacer con cada API.

Guia Consumidor de APIs_API Consumer_14_Captura API CardioAPI_CON ETIQUETAS

A. Información de la API, como el estado, la versión, etc.
B.
Área de suscripción, donde puedes elegir el plan de consumo que te interese y suscribirte a la API. Entramos en detalles unas líneas más abajo.
C. Información general, con la descripción y otras características relacionadas con las redes sociales y los comentarios de los usuarios.
D. Consola de la API, una de las herramientas más importantes de la plataforma, que permite interactuar con la API sin necesidad de código.
E. Documentación, probablemente la otra área más importante de la plataforma, donde está disponible la documentación de cada API.
F. SDKs, para acceder a los 10 SDKs que generamos automáticamente para cada API.
G. Área de aplicaciones, donde gestionarás tus suscripciones, tokens y otras funcionalidades.
H. Área de análisis, donde podrás monitorizar el uso de tus suscripciones, para saber cómo están siendo utilizadas por tus usuarios finales. Un área clave para la gestión óptima de los costes.

Aquí accederá a toda la información disponible sobre la API. La documentación de la API le será útil para aprender a utilizarla.

Los niveles de suscripción deberían ser su siguiente parada. Sólo tiene que seleccionar el nivel de suscripción que más le convenga (muchas APIs incluyen un nivel pequeño gratuito), y suscribirse a él.

Todas las suscripciones requieren la selección de una aplicación.

Guia Consumidor de APIs_API Consumer_15_Suscripcion a CardioAPI_resaltado

Una vez realizada la suscripción, puede elegir entre permanecer en la pantalla de la API o ir a la lista de suscripciones en la pantalla de la aplicación.

Guia Consumidor de APIs_API Consumer_16_Successful suscription

 CONSEJOS E INFORMACIÓN PARA EL CONSUMIDOR DE APIS

En el API Store de Nubentos, una Aplicación es una entidad que debes crear (o usar la predeterminada) para ayudarte a administrar tus suscripciones correctamente.

Cada Aplicación puede tener tantas suscripciones como desees, y generará los tokens que necesitas usar para enviar solicitudes a las API correspondientes.

Cada Aplicación gestiona sus propios tokens. Puedes establecer el tiempo de vencimiento de los tokens, tras el cual debes enviar una solicitud de renovación.

Desde el detalle de cada Aplicación, puedes ver sus suscripciones activas y cancelar la suscripción en caso de que necesites moverla a otra Aplicación o hayas decidido no usarla más.

Quizás te preguntes por qué deberías necesitar más de una aplicación. Usar diferentes aplicaciones puede ser útil en ciertos casos. Veamos un par de ellos.

DIFERENTES SEGMENTOS DE CLIENTES

Por ejemplo, supongamos que tienes diferentes clientes en tamaño. Tienes un gran cliente y un pequeño cliente. Tiene sentido que el gran cliente tenga más usuarios y pueda afrontar más costes. Y el pequeño tendrá menos usuarios y menos presupuesto.

La API que deseas integrar en tu software, ofrece dos planes de suscripción: uno pequeño, hasta 1,000 solicitudes por mes y una tarifa de 0,02 € por solicitud, y uno grande, hasta 10,000 llamadas por mes, y un tarifa de 0,04 € por llamada.

Para optimizar tus costos de desarrollo, te gustaría utilizar el plan pequeño para tu cliente pequeño y el plan grande para tu cliente grande.

Puedes hacer esto creando dos Aplicaciones.

Luego puedes suscribirte al plan grande en una Aplicación, y al plan pequeño en la otra.

La aplicación que tiene tu suscripción al plan grande, gestionará los tokens que se utilizarán en tu código para tu cliente grande (en una versión específica de tu producto, por ejemplo).

Y la otra aplicación, que tiene tu suscripción al plan pequeño, administrará los tokens que usarás en tu código para tu cliente pequeño (en una versión separada de tu producto, o con los tokens parametrizados).

De esta forma, tus costes se calcularán por separado, aunque provendrán del mismo producto software. Para cada suscripción, se aplicarán sus costes específicos.

De esta manera, puedes optimizar tus costes y ajustarlos a los diferentes clientes que puedas tener para tu software.

DIFERENTES PRODUCTOS SOFTWARE

Otra buena razón para usar diferentes Aplicaciones es para ayudarte a monitorizar cómo usan tus usuarios tus APIs y tener una visión más granular para tomar mejores decisiones de gestión basadas en su comportamiento y sobre tus costes de desarrollo.

Por ejemplo, supongamos que tienes dos productos software diferentes, y que deseas integrar la misma API en ambos.

Puedes crear dos aplicaciones en el API Store de Nubentos y suscribirte a la misma API en cada aplicación (incluso al mismo plan de suscripción si se adapta a ambos casos de negocio).

Deberás utilizar diferentes tokens en cada producto software.

Al hacer esto, cuando uses tu panel de Analytics dentro del API Store de Nubentos, se te mostrarán los datos para cada Aplicación por separado, en lugar de todos juntos.

La información que verás coincidirá con el uso real de cada software, realizado por los usuarios finales de cada producto.

Podrás comprender mejor cómo los usuarios finales de cada producto utilizan tu API y gestionar tus costes de desarrollo de manera más adecuada.

PRUEBA LAS APIs

La primera vez que se suscribe a una API, debe generar los tokens que se utilizarán en sus solicitudes. Esto es así sólo en el caso de que sea su primera suscripción en la Aplicación seleccionada, ya que los tokens se generan y gestionan dentro de las Aplicaciones y se aplican a todas sus suscripciones.

Si este es su caso, debe ir a la pantalla de la Aplicación, y generar las claves en la pestaña correspondiente al entorno al que quiere enviar sus peticiones.

Cuando utilice su API por primera vez, querrá probarla en el entorno Sandbox. De lo contrario, puede generar costes para usted, siempre que se haya suscrito a un nivel de pago.

Por lo tanto, nuestra sugerencia es generar sólo el token para el entorno Sandbox.

Guia Consumidor de APIs_API Consumer_17_Sandbox keys

Observe que esta acción también ha generado la clave del consumidor y el secreto del consumidor.

Guia Consumidor de APIs_API Consumer_17b_claves generadas

También puedes establecer el tiempo de caducidad del token en este entorno, expresado en segundos (60 minutos por defecto, valor negativo si quieres que tu token no caduque nunca).

Guia Consumidor de APIs_API Consumer_17c_validity period

Una vez que tenga sus tokens generados desde la Aplicación que tiene su suscripción, puede utilizarlos en la Consola de Pruebas Integrada.

Preste atención a seleccionar el entorno Sandbox antes de enviar cualquier prueba. El token generado para ese entorno aparecerá automáticamente en el campo «Set Request Header«.

Guia Consumidor de APIs_API Consumer_18_Test the API

Sólo tiene que hacer clic en su ficha en el detalle de la API, y podrá probar cada recurso (método). Para continuar, haga clic en el botón «Probar» para editar los parámetros de entrada. Después de proporcionar sus valores, puede comprobar la respuesta devuelta tras hacer clic en el botón «Ejecutar«.

Guia Consumidor de APIs_API Consumer_18_run the test

Casi instantáneamente recibirá la respuesta de la API remota. Un código HTTP de respuesta 200 significa «ejecución exitosa», y se muestran los datos recibidos en la respuesta.

Guia Consumidor de APIs_API Consumer_18_see the response

CONSEJOS E INFORMACIÓN

Puede probar su API todo lo que quiera, pero preste atención a utilizar siempre el token de Sandbox.

Tenga en cuenta que ninguna prueba le generará costes, independientemente del nivel de suscripción al que esté suscrito mientras utilice el entorno de Sandbox.

Esto significa que, aunque esté suscrito a un nivel de pago, no le generará costes hasta que utilice el token de producción (y el entorno).

Tenga en cuenta que si su cuenta está suscrita a nuestro plan SaaS gratuito, dispondrá de 50 usos gratuitos, incluyendo sandbox y producción. Una vez que llegue a esa cuota, su cuenta se bloqueará hasta que actualice su plan.

INTEGRA LA API EN TU SOFTWARE

Cuando termine de probar su API y tenga claro cómo va a utilizarla en su software, haga clic en la pestaña SDK del detalle de la API y descargue el SDK correspondiente a su tecnología de desarrollo.

Guia Consumidor de APIs_API Consumer_19_SDKs

CONSEJOS E INFORMACIÓN

Hemos publicado un artículo específico para ayudarte a integrar tu API en tu software utilizando el SDK que has descargado. Te animamos a leerlo aquí.

MONITORIZA TUS SUSCRIPCIONES PARA CONTROLAR LOS COSTES

Una vez que su software con la API integrada se despliegue a sus usuarios finales, y éstos comiencen a utilizarlo, cada uso generará costes para usted (siempre que se haya suscrito a un nivel de pago).

En caso de que se suscriba a un nivel de suscripción con una cuota fija, la plataforma hará un seguimiento de cada uso para aplicar la tarifa correcta al final de cada mes.

Puede monitorizar el uso que sus usuarios finales hacen de sus suscripciones a la API, a través de las Analíticas que tiene a su disposición en Nubentos API Store.

Guia Consumidor de APIs_API Consumer_20_Analytics

CONSEJOS E INFORMACIÓN

Esto será útil para mantener el control de posibles usos indebidos que podrían convertirse en sobrecostes para usted, o para supervisar si su nivel de uso estimado cuando eligió el nivel de suscripción al que se suscribió era correcto.

En caso de que vea que hay demasiadas solicitudes estranguladas, lo que significa que el uso real de su software implica más solicitudes de las esperadas, puede considerar la posibilidad de actualizar a un plan superior con el fin de ampliar su umbral de consumo, mejorar la experiencia de sus usuarios (evitando las solicitudes rechazadas) o evitar las tarifas por solicitudes adicionales.

Por supuesto, también se puede comprobar la situación contraria, y puede considerar apropiado cambiar a un plan menor si ve que sus estimaciones eran demasiado altas.

Tenga en cuenta que los niveles de consumo que verá en las APIs, corresponden a la cuota asignada a su actual plan SaaS en su cuenta de usuario. Por lo tanto, puede ser necesario actualizar a un plan SaaS más alto en su cuenta de usuario, con el fin de desbloquear niveles de consumo más altos en sus APIs.

CONCLUSIONES

En este post, hemos recorrido los principales pasos que debes seguir para integrar con éxito en tu software la solución de Salud Digital proporcionada a través de una API publicada en Nubentos API Store.

También hemos mostrado cómo puedes utilizar diferentes Aplicaciones para determinadas situaciones, para ayudarte a tomar mejores decisiones de gestión y mantener tus costes de desarrollo bajo control.

Hemos visto lo fácil que es probar su API antes de escribir cualquier código.

Finalmente, hemos visto que cada API publicada en Nubentos tiene 10 SDK diferentes disponibles para ti. Sólo tienes que elegir el que se adapte a tu tecnología de desarrollo, y tendrás todos los recursos técnicos que necesitas para implementar las peticiones y gestionar las respuestas de tu nueva API.

La conclusión es que el uso de Nubentos API Store para integrar soluciones de salud digital le ofrece más que la propia solución. Le da las herramientas necesarias para hacerlo con costes óptimos, de forma estandarizada, y para ayudarle a reducir su tiempo de comercialización, sus costes de mantenimiento y a tomar las mejores decisiones de gestión sobre cómo sus usuarios finales utilizan la solución a través de sus integraciones.

0 comentarios

Enviar un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Your competitors know, don’t be left out.

Receive in your mail all the news about Nubentos: articles, eBooks, new APIs, interviews, guides, etc. in our Newsletter with the best of each month.