+34 688 911 123 hola@nubentos.com

Publicar tu API en Nubentos es un proceso fácil que no te llevará mucho tiempo. Al final de este sencillo proceso tu API estará disponible para toda la comunidad de desarrollo de software sanitario. Sigue los pasos de este tutoríal, donde te contamos cómo publicar tu API de Sanidad en 10 minutos.

Qué aprenderás

En este tutorial, aprenderás cómo:

  • Cómo publicar una API de ejemplo

Qué necesitas:

Asegúrate de que dispones de lo siguiente antes de comenzar:

  • Tu cuenta de acceso al API Publisher de Nubentos. Si aún no la tienes, tienes que solicitarnos acceso. Te lo explicamos en nuestras FAQs para el proveedor de APIs.
  • La especificación de la API que vas a publicar. Para nuestro ejemplo vamos a implementar una API que nos permite verificar un número de teléfono, llamada “PhoneVerify

Sobre el servicio PhoneVerify.

El servicio PhoneVerify que vamos a usar en este tutorial es de acceso libre. No requiere clave API o token de acceso.

El servicio dispone de dos operaciones, pero solo usaremos “CheckPhoneNumber”

  • CheckPhoneNumber:
    • PhoneNumber: Número de teléfono con código de país que vamos a verificar.
    • Licencia: En nuestro caso, dado que vamos a usar la capa gratuita, debemos indicar un valor de “0”.

Para más información sobre esta API y sus operaciones echa un vistazo al siguiente enlace: https://cdyne.com/phone-verify/developers/quick-start.

Publicar nuestra API

Primero, crearemos nuestra API con los siguientes pasos:

  1. Acceder al API Publisher de Nubentos.
  2. Introduce tus credenciales de inicio de sesión y haz clic en Sign In .
  3. Asegúrate de estar en la interfaz de usuario de Nubentos.

 

  1. Selecciona “New API…” si aún no has creado ninguna API previamente, o sobre “ADD NEW API” en caso contrario.

 

  1. Como método para crear nuestra API usaremos “Design a New REST API”, así que elegiremos esta opción y a continuación “Start Creating”.

 

  1. Ahora debemos cumplimentar el formulario. En “General Details” , indicaremos:
    • Name: El nombre con que identificamos el servicio.
    • Context: La ruta única donde estará accesible, “phoneverify”
    • Versión: La versión de esta implementación, “1.0.0”
    • Visibility: Debemos indicar la visibilidad de la API como “Public
    • Description: Una descripción indicativa de la API. Es importante, porque es la primera información que verán tus visitantes.
    • Tags: Introduce las etiquetas que se usarán para localizar tu API. “Tool”, en nuestro ejemplo.
    • Thumbnail Image: Una imagen para hacer más visual la API.

 

  1. Cumplimentamos los datos de la definición de la API en “API Definition
    • URL Pattern: Indicará la operación que vamos a agregar, “CheckPhoneNumber”
    • Los métodos asociados a esta operación , GET y POST

 

  1. Ahora debemos añadir los parámetros en cada método. Comenzaremos con el método “GET”
    • Actualiza los valores para el formato que genera el servicio (“Produces” application/xml) y el que consume («Consumes» application/json)

     

    • A continuación introducimos los parámetros según la siguiente tabla:
Parameter Name Description Parameter Type Data Type Required
PhoneNumber Give the phone number to be validated query string True
LicenseKey Give the license key as 0 for testing purpose query string True

 

    • El resultado será como se muestra a continuación:

 

  • Para el método POST no es necesario añadir ningún parámetro.
  • Por último pulsamos sobre el botón “Next: Implement
  1. El siguiente paso será implementar la API pulsando sobre “Managed API”. Esta opción significa que la API está en realidad fuera de Nubentos, por lo que debes proporcionar la URL en la que están disponibles sus endpoints.

     

    • Pulsamos sobre “Next: Manage” para continuar.
  1. Definimos la configuración de “Throttling” , marcando sobre el o los niveles de prestación de servicio que queremos proporcionar.
    • Subscription Tier: Serán las distintas capas de subscripción de que dispone el servicio de backend.

 

  • Elegiremos estos dos por ejemplo.
  • Por último pulsamos sobre “Save & Publish
  1. Tu servicio estará publicado y accesible en tu store privado.

 

  1. El último paso es muy importante, para que tu API esté publicada en el API Store externo de Nubentos. Para ello seguiremos estos últimos pasos:
      • Selecciona la pestaña “External API Store”

     

    • Marca la casilla “Catálogo Nubentos” y haz clic en “Save”.

Siguiendo estos pasos, tendrás tu API publicada y accesible en el API Store de Nubentos.

0 comentarios

Enviar un comentario

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

Share This