FAQs API Publisher

En Nubentos queremos garantizar a todo el ecosistema sanitario que las APIs que publicamos aportan un alto valor añadido al sector y resuelven o ayudan a resolver casos de negocio de interés para los procesos de negocio de Salud Conectada.

 

Nuestra plataforma para la publicación de APIs en Sanidad no está abierta al público. Nosotros invitamos a las empresas que queremos que publiquen sus APIs en nuestro Marketplace. En caso de que no hayamos contactado con tu empresa, y quieras publicar tus APIs en Nubentos, debes seguir el siguiente proceso:

1. Contactar con Nubentos para solicitar ser cliente. Para ello debes usar el formulario de contacto publicado en nuestra web para la solicitud de nuevos clientes. Desde este momento nuestra relación queda sometida a nuestros Términos y Condiciones de uso, que incluye una estricta cláusula de confidencialidad.
2. Facilitarnos la información que te solicitaremos sobre la/s API/s que deseas publicar y el/los caso/s de negocio implicados.
3. Estudiaremos tu solicitud y la información facilitada, y en caso de superar los criterios de publicación, contactaremos contigo para confirmarte tu incorporación al API Markeplace de Nubentos como proveedor de APIs. A partir de aquí, comenzaremos a trabajar juntos para tener tus APIs publicadas lo antes posible.

Lo primero que haremos será preparar una sección en el API Marketplace de Nubentos para que publiques tus APIs. Puedes visualizarlo como si en unos grandes almacenes preparasen un área exclusiva para tus productos.

 

De hecho nuestro API Marketplace funciona de forma similar a unos grandes almacenes. Todas las APIs están publicadas en un Store público, que hace las veces de escaparate. Cualquier persona que visite de forma anónima nuestro Store público puede ver las APIs publicadas, como si un paseante se detuviera en los escaparates de unos grandes almacenes.

 

Para poder “adquirir” una de tus APIs, el visitante anónimo debe registrarse e identificarse en la sección específica preparada para tus APIs. Dispondrá también de tu información de contacto por si necesita aclarar dudas o ampliar la información publicada en tus APIs antes de decidir suscribirse para incorporarlas a su software.

 

La preparación de tu sección en el API Marketplace de Nubentos requiere de algunos pocos datos que deberás facilitarnos, y en 48 horas dispondrás de acceso para publicar tus APIs.

Por defecto, preparamos dos niveles de credenciales para nuestros clientes:

1. Creador de APIs. Orientada a un perfil técnico, este usuario tendrá los permisos necesarios para crear y configurar las APIs, pero no para gestionar tu ciclo de vida.
2. Publicador de APIs. Orientada a un perfil consultor o de negocio, este usuario tendrá los mismos permisos que el nivel anterior, y además los permisos necesarios para gestionar el ciclo de vida de las APIs.

 

Esta separación de roles pretende otorgarte un nivel de seguridad y control para el gobierno de tus APIs, evitando que un determinado perfil realice cambios para los que no está autorizado.

 

Si tienes unos requerimientos diferentes en cuanto a credenciales de accesos y permisos, por favor contacta con nosotros y analizaremos tu caso.

 

No facilitamos permisos de administración a nuestros clientes. Todas las tareas de administración son realizadas en exclusiva por Nubentos, tanto en el API Marketplace global como en cada sección de nuestros clientes.

Antes de crear tus APIs, debemos configurar tus planes de precios. Cuando publiques tu API podrás seleccionar cuál de tus planes publicar. Y opcionalmente, puedes establecer políticas de limitación de tráfico (políticas de throttling).

 

Para que demos de alta los planes de precios que quieres ofrecer a los suscriptores de tus APIs, debes facilitarnos los detalles de dichos planes. Para cada plan que quieras dar de alta debes establecer:

• Nombre del plan. Algunos ejemplos: Oro, Plata, Bronce, Plus, Estándar, Básico, Premium, etc, etc.
• Descripción del plan. Se trata de la descripción que verá el suscriptor a la hora de seleccionar el nivel de consumo al que se suscribe. Algunos ejemplos:
  • Plan de uso de 1.000 peticiones por minuto, con una cuota plana mensual de 90€, y una tarifa por petición extra de 0,02€.
  • Plan de uso de 50.000 peticiones por hora, a 0,05 euros cada petición. En este caso no se permiten peticiones por encima del nivel establecido, por lo que no se indica una tarifa por petición extra.
  • Plan de uso gratuito hasta 1.000 peticiones por día, sin tarifa por petición extra.
• Control de pico de tráfico. Junto con el tramo de consumo que establezcas para el plan, puedes establecer un límite de ráfaga de tráfico por segundo. Este parámetro puede protegerte de usos indebidos de tu API.
• Bloqueo en el límite de tráfico. Puedes decidir que las peticiones que sobrepasen el nivel de consumo de tu plan sean rechazadas, o que sean aceptadas para por ejemplo aplicarles una tarifa especial. A menos que establezcas una tarifa especial para peticiones extra, lo más razonable es activar este bloqueo.

 

Puedes definir tantos planes de consumo como desees, ya que cuando configures cada nueva API podrás elegir qué planes se ofrecen a los posibles suscriptores que accedan a la API publicada en el Store.

 

Cuando ofrezcas exclusivamente planes de uso gratuitos, tu API será publicada como FREE. Cuando ofrezcas tanto planes de uso gratuitos como planes de uso comercial (con tarifa), tu API será publicada como FREEMIUM. Cuando ofrezcas exclusivamente planes de uso comercial, tu API será publicada como PAID.

 

Naturalmente puedes solicitarnos nuevos planes en cualquier momento, así como las políticas de limitación de tráfico que creas convenientes.

Para publicar tus APIs en Nubentos, dispones de unas guías completas en la documentación en línea de nuestro proveedor tecnológico, en función de la tecnología de tus APIs:

https://docs.wso2.com/display/AM210/Create+and+Publish+an+API

https://docs.wso2.com/display/AM210/Create+and+Publish+an+API+from+Swagger+definition

https://docs.wso2.com/display/AM210/Create+a+Prototyped+API+with+an+Inline+Script

https://docs.wso2.com/display/AM210/Deploy+and+Test+as+a+Prototype

https://docs.wso2.com/display/AM210/Create+a+WebSocket+API

https://docs.wso2.com/display/AM210/Create+and+Publish+a+SOAP+API

 

***MUY IMPORTANTE***: En todos los casos, debes además tener en cuenta algunos detalles concretos del API Marketplace de Nubentos que debes seguir para garantizar la máxima visibilidad de tus APIs y una adecuada experiencia de uso al visitante de tu Store:

 

1. tus APIs deben tener visibilidad Pública. En la pestaña “Design” de la creación de una nueva API, debes informar siempre el campo “Visibility” como “Public”.
2. Etiquetas (Tags) informadas correctamente. En la pestaña “Design” de la creación de una API, debes informar la/s etiqueta/s que permitan localizar tu API de forma coherente. Revisamos periódicamente las etiquetas de las APIs publicadas para mantener un conjunto homogéneo de etiquetas que ayude al posible suscriptor a localizarlas fácilmente.
3. La suscripción a tus APIs debes estar permitida solo a usuarios de tu organización. En la pestaña “Manage” de la creación de una API, en el campo “Subscriptions” debes informar siempre “Available to current tenant only”.
4. Debes informar los datos de contacto. En la pestaña “Manage” de la creación de una API, la sección “Business Information” te permite informar los datos del responsable funcional o de negocio de la API, y del responsable técnico de la API. Debes informar ambos contactos.
5. Debes confirmar la visualización de tu API en el API Store Público de Nubentos. Cuando tu API esté publicada, y sólo entonces, tendrás disponible en la API una nueva pestaña para confirmar la visualización de la API en el API Store público de Nubentos. Debes marcar la casilla de la API Store Pública de Nubentos y guardar. Si no realizas esta acción, tu API estará publicada en tu sección pero no en el Catálogo de APIs público de Nubentos, con lo que perdería visibilidad.

Para documentar tus APIs, primero debes haberlas creado. Desde la pestaña “Docs” de la API puedes añadir documentos a tu API que estarán disponibles para tus visitantes en función de la visibilidad que le asignes.

 

El primer nivel de documentación, al que debes prestar especial atención, es la descripción de la API. Este texto estará visible en la ficha de tu API en el Store Público de Nubentos, y por tanto será la primera y única información que verá un visitante anónimo del Catálogo. Es muy importante que la descripción de tu API muestre claramente y de forma concisa en qué consiste y el valor que aporta.

 

Existen distintas formas de documentar tus APIs en el API Marketplace de Nubentos:

• Puedes subir archivos de documentos desde tus sistemas para que sean descargados desde Nubentos por los suscriptores de tus APIs.
• Puedes enlazar documentos mediante tu URL para que sean consultados directamente en tus servidores o en tu gestor documental.
• Puedes crear y editar directamente en línea con el editor que incorpora Nubentos.

 

Para cada uno de los documentos, puedes establecer su nivel de visibilidad entre los siguientes:

• Misma visibilidad que la API (“Same as API visibility”) , por lo que sería pública y disponible para cualquier usuario que visite tu sección en la API Store de Nubentos, sin necesidad de registrarse como usuario ni de suscribirse a la API.
• Visible sólo para tu sección (“Visible to my Domain”), por lo que sería visible únicamente para usuarios registrados en tu sección de la Store, aunque no se hayan suscrito a la API.
• Privada (“Private”), con lo que sería solo visible para usuarios de tu sección con permisos de creación, edición y modificación de APIs (normalmente usuarios de tu organización). Este nivel de visibilidad hace que el documento no esté disponible para visitantes ni suscriptores. Es por tanto apropiada para documentación interna, o para documentación que aún no está finalizada, por ejemplo.

Al empezar a utilizar el API Publisher de Nubentos, te facilitamos un usuario con permisos para gestionar el Ciclo de Vida de tus APIs, lo que implica acciones como publicar una API creada (“publish”), declarar una API obsoleta (“deprecate”) y retirar APIs (“retire”).

 

Para ello, en la pestaña “Lifecycle” de la API podrás realizar las transiciones de estado que desees conforme al Ciclo de Vida que se muestra en el visor. Dispones también de todo el histórico de estados por los que ha pasado tu API.

Nubentos incorpora herramientas de monitorización y analíticas del uso de las APIs, con las que puedes analizar el comportamiento de tus suscriptores, el rendimiento de tus APIs, y otros datos de interés.

 

Para acceder a toda esta información, dispones de la opción “Analytics” del menú lateral izquierdo.

Mensualmente te enviaremos un informe detallado con:

• el uso que han tenido tus APIs por cada suscriptor,
• el plan de uso al que se ha suscrito cada suscriptor de cada API,
• el importe a facturar a cada suscriptor, resultante de aplicar el plan suscrito al tráfico generado.

 

Con esta información y la información de contacto del suscriptor podrás generar tus facturas.