+34 688 911 123 hola@nubentos.com

¿Interesado en integrar algunas de nuestras APIs de salud digital en tu software? ¿Estás un poco confundido acerca de por dónde empezar, cómo hacerlo o qué pasos seguir? Este artículo es para ti (y tu equipo de TI). Hemos preparado esta guía rápida para el Consumidor de APIs en Nubentos pensando en ti, poniéndonos en tu lugar y reuniendo todo lo que nos gustaría encontrar si fuéramos tú.

Empecemos.

ENCUENTRA TU API

En nuestra API Store pública, haz clic en la API de tu interés.

Te llevará a cierta información sobre la API, con un botón para visitar la tienda del proveedor (Visit Publisher Store).

Haz clic en ese botón.

 

Find your API Visit publisher store nubentos

 

CONSEJOS E INFORMACIÓN

Al hacer clic en una API etiquetada como «SOON», no encontrarás el botón «Visit Publisher Store». En su lugar verás un formulario de suscripción. Puedes usarlo para recibir información por correo electrónico tan pronto como la API esté completamente disponible.

El estado «SOON» («COMING SOON») significa que la API ya se está publicando y estará disponible como API FREE, FREEMIUM o PAID en un futuro próximo.

REGÍSTRATE EN LA API STORE

Se abrirá una nueva pestaña.

Ahora estás en la API Store privada del proveedor. Allí verá todas las API publicadas por ese proveedor específico.

Aquí debes iniciar sesión como usuario registrado para obtener acceso a toda la información de la API. Por tanto, si ya se ha registrado, debes iniciar sesión ahora. De lo contrario, tienes que registrarte.

Encontrarás ambas opciones en la esquina superior derecha.

 

Sign up  Sign in nubentos

 

CONSEJOS E INFORMACIÓN

Al registrarte, te estás registrando en el API Store privado del proveedor. Para cualquier otro proveedor, seguirás siendo un usuario no registrado.

Cuando inicies sesión, recuerda agregar «@publisherdomain.com» a tu ID de usuario.

Por ejemplo, supongamos que te registras con un identificador de usuario «myuserid» en el API Store de Medicsen en Nubentos. Cuando inicies sesión, debes escribir «myuserid@medicsen.com» en el campo de ID de usuario. Es como decir «Estoy registrado como myuserid en medicsen.com».

Otro detalle importante que debes tener en cuenta: cuando termines el paso de registro e ingreses tus nuevas credenciales como se explicó anteriormente, se te pedirá que selecciones la tienda del proveedor en la que deseas iniciar sesión. Esto significa que, si te has registrado en el API Store de Medicsen, debes seleccionar el Store Medicsen.com cuando se te solicite.

Puedes elegir cualquier otra tienda de proveedores, pero tus nuevas credenciales solo te darán acceso completo a las APIs de Medicsen, que se encuentran solo en el Store Medicsen.com.

Para tener acceso completo a las APIs de otros proveedores, regístrate en su API Store privada y usa su dominio para iniciar sesión (myuserid@providersdomain.com).

SUSCRÍBETE A LA API

Ahora accederás a toda la información disponible sobre la API. La documentación de la API será útil para aprender a usarla.

Los planes de suscripción deberían ser tu próxima parada. Simplemente selecciona el plan de suscripción que más te convenga (muchas API incluyen un plan pequeño gratuito) y suscríbete a él.

Todas las suscripciones requieren seleccionar una Aplicación.

 

Subscribe nubentos

 

Tras suscribirte con éxito, puedes optar por permanecer en la pantalla de la API o ir a la lista de suscripciones en la pantalla de la Aplicación.

 

Subscription successful nubentos

 

CONSEJOS E INFORMACIÓN

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 LA API

La primera vez que te suscribes a una API, debes generar los tokens que se utilizarán en tus solicitudes. Esto es cierto en caso de que esta sea tu primera suscripción en la Aplicación seleccionada, porque los tokens se generan y administran dentro de las Aplicaciones y se aplican a todas sus suscripciones.

Si este es tu caso, debes ir a la pantalla de la Aplicación y generar las claves en la pestaña correspondiente al entorno al que deseas enviar tus solicitudes.

Cuando uses tu API por primera vez, querrás probarla en el entorno Sandbox. De lo contrario, puede generar costes para ti, siempre que te hayas suscrito a un nivel de pago.

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

 

Application token generation nubentos

 

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

También puedes establecer el tiempo de vencimiento del token en este entorno, expresado en segundos (60 minutos de forma predeterminada, valor negativo si deseas que tu token nunca caduque).

Una vez que hayas generado tus tokens desde la Aplicación que tiene tu suscripción, puedes usarlos en la Consola de prueba integrada.

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

 

Test sandbox token nubentos

 

Simplemente haz clic en su pestaña en los detalles de la API, y podrás probar cada recurso (método), proporcionando los parámetros de entrada y comprobando la respuesta devuelta después de hacer clic en el botón «Try it out!» .

 

Test API Console nubentos

 

CONSEJOS E INFORMACIÓN

Puedes probar tu API todo lo que quieras, pero presta atención para usar siempre el token Sandbox.

Ten en cuenta que ninguna prueba generará costes, independientemente del nivel de suscripción al que estés suscrito , siempre que uses el entorno Sandbox.

Esto significa que, aunque te suscribas a un nivel pagado, no generarás costes hasta que uses el token de producción (y el entorno).

Por supuesto, si tu nivel de suscripción es gratuito, lo será tanto en el entorno sandbox como en el entorno de producción.

INTEGRA LA API EN TU SOFTWARE

Cuando termines de probar tu API y tengas una idea clara de cómo la vas a usar en tu software, haz clic en la pestaña SDK en los detalles de la API y descarga el SDK correspondiente a tu tecnología de desarrollo.

 

Integrate SDK nubentos

 

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 tu software con la API integrada se entregue a tus usuarios finales y comiencen a usarlo, cada uso generará costes para ti (siempre que te hayas suscrito a un plan de pago).

En caso de que te hayas suscrito a un plan de suscripción con una cuota fija, la plataforma realizará un seguimiento de cada uso para aplicar la tarifa correcta al final de cada mes.

Puedes monitorizar el uso que tus usuarios finales hacen de tus suscripciones a la API, a través de las Analytics que tienes a tu disposición en el API Store de Nubentos.

 

Monitor analytics nubentos

 

CONSEJOS E INFORMACIÓN

Esto será útil para mantener el control de posibles usos indebidos que podrían convertirse en sobrecostes para ti o para monitorizar si tu nivel de uso estimado cuando elegiste el plan de suscripción al que te suscribiste era correcto.

En caso de que veas que hay demasiadas solicitudes rechazadas, lo que significa que el uso real de tu software implica más solicitudes de las esperadas, puedes considerar actualizar a un plan más alto para ampliar tu umbral de consumo, mejorar la experiencia de tus usuarios (evitando solicitudes rechazadas) o evitar tarifas por solicitudes adicionales.

Por supuesto, la situación opuesta también puede verificarse, y puedes encontrar apropiado cambiar a un plan más pequeño si ves que tus estimaciones eran demasiado altas.

CONCLUSIONES

En este artículo, hemos recorrido los pasos principales 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 el API Store de Nubentos.

También hemos mostrado cómo puedes usar diferentes Aplicaciones para ciertas 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 tu API antes de escribir cualquier código.

Finalmente, hemos visto que cada API publicada en Nubentos tiene 10 SDK diferentes disponibles para ti. Simplemente elige el que coincida con tu tecnología de desarrollo, y tendrás todos los recursos técnicos que necesitas para implementar las solicitudes y administrar las respuestas de tu nueva API.

La conclusión es que el uso de la API Store de Nubentos para integrar soluciones de Salud Digital te brinda más que la propia solución. Te proporciona las herramientas necesarias para hacerlo bajo costes óptimos y para ayudarte a tomar las mejores decisiones de gestión sobre cómo tus usuarios finales usan la solución a través de tus productos software.

 

0 comentarios

Enviar un comentario

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

Share This