FAQs API Store

Las APIs publicadas en Nubentos están etiquetadas para facilitar su localización. Dispones de todas las etiquetas en la sección lateral izquierda del API Store, donde puedes seleccionarlas para que se visualicen únicamente las APIs con la etiqueta seleccionada.

 

Además del sistema de etiquetas, el API Store de Nubentos ofrece una herramienta de búsqueda que te permite localizar las APIs con distintos criterios:

• Por el nombre de la API, simplemente escribiendo el nombre de la API o una parte del nombre en el campo de búsqueda.
• Por el proveedor de la API, escribiendo provider:xxxx en el campo de búsqueda. El proveedor de una API es el usuario que la ha creado.
• Por la versión de la API, mediante version:xxxx en el campo de búsqueda.
• Por el contexto de la API, usando la expresión context:xxxx.
• Por el estado de la API, escribiendo status:xxxx.
• Por la descripción de la API, usando la expresión description:xxxx.
• Por subcontexto de la API, mediante subcontext:xxxx. El subcontexto es cualquier recurso definido en la creación de la API.
• Por el contenido de la documentación de la API, usando la expresión doc:xxxx.

Cuando una API del Store de Nubentos sea de tu interés y quieras suscribirte, utiliza el botón “Visit Publisher Store” para visitar la sección del Store de la empresa proveedora de esa API.

 

Una vez ahí, dispones de más opciones, como por ejemplo, registrarte gratuitamente. Estar registrado es condición necesaria para poder suscribirte a una API. Las APIs que estén desplegadas como prototipo pueden ser probadas sin necesidad de suscribirte a la API.

 

Para suscribirte a una API debes ser un usuario registrado en la sección del Store de la empresa proveedora de esa API. Una vez registrado, podrás suscribirte a todas las APIs que quieras de ese proveedor.

 

Ten en cuenta que estar registrado en la sección del Store de una empresa proveedora de APIs, no implica estar registrado en la sección del Store de las demás empresas proveedoras. Esto significa que siempre que desees suscribirte por primera vez a una API de un proveedor, debes registrarse en su sección del Store. A partir de ahí, podrás suscribirte al resto de sus APIs.

 

Una vez registrado correctamente en la sección del Store de la empresa que publica la API a la que quieres suscribirte, identifícate usando el usuario seguido del dominio que identifica la sección del Store donde te has identificado, con el mismo formato que una dirección de correo electrónico. Por ejemplo, si te has dado de alta como “usuario1” en el Store de la empresa “empresa1.es”, debes identificarse como “” y tu contraseña.

 

Una vez identificado en la sección de la empresa que publica la API que te interesa, puedes volver a la API para suscribirte.

 

Para ello lo primero que debes hacer es seleccionar o crear una aplicación. Una aplicación es una entidad que te permite agrupar y gestionar tus suscripciones de manera ordenada y desacoplada respecto de las APIs. Puedes tener varias aplicaciones si quieres, y en una aplicación puedes suscribir tantas APIs como quieras, pero cada API estará suscrita en una y sólo una aplicación.

 

Para que entiendas el papel que puede jugar la aplicación en tu uso de la API Store de Nubentos, ten en cuenta que es desde la aplicación desde la que se generan los tokens de seguridad para las APIs suscritas a dicha aplicación. Por tanto, agrupar determinadas APIs en una aplicación te permitirá compartir el mismo token para distintas APIs relacionadas entre sí desde el punto de vista funcional o de negocio.

 

Ten también en cuenta que cuando te suscribes a una API, como veremos enseguida, lo haces a un determinado nivel de servicio. Pero puedes suscribirte varias veces a la misma API en distintos niveles de servicio en una misma aplicación. Esto puede permitirte usar cada API con distintos costes en función del cliente final al que vayas a dirigir tu producto, en función del nivel de consumo que esperes de cada uno.

 

Al crear la aplicación, dispones de distintos niveles de control de throttling (Per Token Quota) que puedes usar para controlar el tráfico global de todas las APIs suscritas en esa aplicación. Si no encuentras una política de throttling adecuada, por favor contacta con nosotros.

 

Una vez creada y/o seleccionada la aplicación, deberás seleccionar el nivel de servicio al que te suscribes para esa API, de la lista que te ofrece el proveedor de la API.

El API Store de Nubentos incorpora una consola integrada que facilita enormemente las pruebas de las APIs publicadas. De hecho, existen varias maneras de hacerlo:

• Cuando una API está desplegada como prototipo, puedes probarla sin necesidad de suscribirte a ella. Para ello, selecciona la pestaña de la API Console, y expande los métodos que quieres probar, informando los parámetros necesarios. Pulsa en “Try it out!” y observa la respuesta generada en las secciones “Response Body”, “Response Code” y “Response Headers”. No necesitas proporcionar un token de autorización cuando la API está desplegada como prototipo.

 

• Cuando una API está publicada, puedes probarla desde la API Console tras suscribirte a ella. Para ello sigue los siguientes pasos:
  • Mediante la opción “Applications” del menú lateral, accede a tu lista de aplicaciones. Esta lista mostrará todas las aplicaciones creadas por ti para suscribirte a las APIs.
  • Selecciona la aplicación con la que te suscribiste a la API que vas a probar, y selecciona la pestaña “Sandbox Keys”. Es muy importante que te asegures de estar en la pestaña “Sandbox Keys”, para usar la url de la versión de prueba de la API, y no la de producción.
  • Observa el tiempo de vigencia del token, que por defecto está fijado en una hora (3600 segundos). Puedes cambiarlo por el valor que prefieras.
  • Presiona en “Generate keys”.
  • Vuelve a la API y abre la pestaña “API Console”. Observa que el token recién generado aparece automáticamente en el campo correspondiente (“Authorization: Bearer”). Asegúrate de que vas a probar la versión Sandbox.
  • Expande los métodos que deseas probar, informa los parámetros necesarios, y presiona en “Try it out!”.
  • Observa el resultado en las secciones “Response Body”, “Response Code” y “Response Headers”.

 

• Existen numerosas herramientas externas que puedes usar para probar las APIs publicadas en Nubentos, contando con que te has suscrito a ellas previamente. Desde cURL, hasta SoapUI, pasando por JMeter, Postman, ReadyAPI, etc., estas herramientas suelen ofrecer funcionalidades avanzadas para planificar pruebas más elaboradas, como pruebas de carga, scripts de pruebas, etc. En algunos casos es necesario instalar algún plugin y/o configurar la conexión con la API.

Cuando visualizas una API, encontrarás la información de contacto del proveedor de la API en la sección “Business Information” en la pestaña “Overview”. En concreto, podrás ver al responsable de negocio y al responsable técnico de la API, así como sus direcciones de correo electrónico.

Registrarte en la API Store de Nubentos no tiene coste alguno. Suscribirte a todas las APIs que te interesen, tampoco. Probar las APIs a las que te hayas suscrito, tampoco tiene ningún coste. También dispones sin coste de las herramientas de analíticas.

 

Sólo tiene costes el consumo en producción de las APIs a las que te hayas suscrito mediante un plan de consumo de pago. Si te suscribes a planes gratuitos que puedan ofrecer las APIs, naturalmente, tampoco te supone ningún coste usarlas en producción.

 

Cada API muestra una etiqueta que indica la modalidad comercial en la que la ofrece su proveedor. Existen tres modalidades:

• FREE: en esta modalidad, todos los niveles de consumo disponibles para suscripción son gratuitos.
• FREEMIUM: en esta modalidad, algunos niveles de consumo disponibles son de pago y otros gratuitos. Cuando te estás suscribiendo a una API publicada bajo modalidad FREEMIUM, tú decides si te suscribes a un plan de pago o a uno gratuito.
• PAID: en este modalidad, todos los niveles de suscripción disponibles son de pago, variando habitualmente en la limitación de tráfico por unidad de tiempo que establece el proveedor de la API.

 

El único coste que asumes al consumir una API es el que corresponda al nivel de suscripción elegido cuando te suscribiste a esa API. La facturación por dicho coste te será enviada directamente por el proveedor de la API.