+34 688 911 123 hola@nubentos.com

Como desarrolladores de software sanitario, tras suscribirnos a alguna de las APIs de nuestro Marketplace para la Salud, necesitaremos hacer pruebas de las APIs a las que nos hemos suscrito antes de incorporarlas a nuestra aplicación. La plataforma de Nubentos proporciona desde el API Store la posibilidad de hacer pruebas de cada uno de los recursos que componen la API.

En este Howto mostraremos los pasos a seguir.

Qué aprenderás

En este tutorial, aprenderás cómo:

  • Crear una Aplicación para suscribirnos y hacer las pruebas.
  • Realizar una prueba simple de un recurso de la API.

Qué necesitas

Para seguir este tutorial, debes disponer de tu cuenta de usuario en el API Store de Nubentos. Para obtener tu cuenta de usuario debes registrarte usando la opción correspondiente que encontrarás en el ángulo superior derecho del API Store.

 

En este how to usaremos una API de pruebas llamada “MedicalAPI”. A lo largo del artículo, cuando hagamos referencia a esta API puedes aplicar los pasos a la API que tú estés usando.

Crear una Aplicación para pruebas

El primer paso consiste en crear una aplicación donde agregaremos las suscripciones a las APIs que nos interesan. Esto nos permitirá establecer los límites de uso y poder generar los tokens de seguridad necesarios para poder consumir las APIs.

Los pasos para crear la aplicación son los siguientes:

  1. Accedemos al API Store de Nubentos, donde localizaremos la API que nos interesa y accederemos al Store de su publicador mediante el correspondiente botón Visit Publisher Store.
  2. Una vez en el API Store del propietario de la API, ingresamos las credenciales de inicio de sesión y haremos clic en Sign In.
  3. Recuerda que en este How to usaremos una API de pruebas llamada “MedicalAPI”. En tu caso puedes seguir estos pasos con otra API de tu interés.

 

  1. En el menú de la izquierda seleccionamos “Applications”. Por defecto nos aparecerá una única aplicación llamada “DefaultApplication”.

 

  1. Vamos a crear una nueva aplicación pulsando sobre el botón “ADD APPLICATION”, en la parte superior.

 

  1. Rellenamos los datos y pulsamos sobre el botón “Add”:
    • Name: Nombre que le daremos a nuestra aplicación, por ejemplo “TestAPP”.
    • Per Token Quota: Límite de peticiones, dado que vamos a realizar una prueba simple indicaremos “10PerMin” . Esto nos ayudará a controlar el consumo del plan al que nos vayamos a suscribir.
    • Descripción: Indicaremos el uso que le vamos a dar a esta aplicación, por ej. “This app is used to test MedicalAPI”.

 

  1. En el menú de nuestra aplicación podremos generar las claves para cada entorno y ver las suscripciones actuales. Vamos a generar las claves para el entorno SandBox pulsando sobre la pestaña “Sandbox Keys”.

 

  1. En la parte inferior de esta pantalla podremos ver el token de acceso que emplearemos en las peticiones que enviaremos a la API, y el tiempo de validez de la misma.

Ahora podremos suscribir nuestras APIs a esta aplicación y realizar la prueba.

Realizar una prueba simple de un recurso de una API

  1. Pulsamos sobre APIS en el menú de la izquierda y sobre el icono de la API “MedicalAPI” .

 

  1. En la parte derecha seleccionamos la aplicación “TestAPP” y en Tier seleccionamos el nivel que queramos, y pulsamos sobre el botón “Subscribe” .
  2. Nos aparece una pantalla indicando que nos hemos suscrito correctamente y nos invita a visualizar la suscripción, nosotros elegiremos la opción de permanecer en la página actual, pulsando sobre “Stay on this page“.

 

  1. En la página de detalle de la API, pulsamos sobre la pestaña de “API Console” y probaremos nuestra aplicación “TestAPP” con el entorno “Sandbox”. Automáticamente se actualizará el token de autorización que generamos en un paso anterior.

 

  1. Si descendemos por la página veremos la lista de cada recurso disponible. Nos desplazaremos hasta llegar a “/pacient/{pacientname}”.

 

  1. Pulsamos sobre el recurso GET y se despliega una sección con la información relativa a este recurso. En ella podemos identificar en la parte superior derecha una pequeña descripción, en la zona central el formato de una respuesta correcta con código 200 y en la parte inferior otros mensajes para cada uno de los códigos de error controlados.

 

  1. Rellenamos el campos para introducir el nombre del paciente “pacientname” y pulsamos sobre el botón “Try it out” de la parte inferior. La pantalla se actualizará para mostrarnos ciertos comandos y el resultado de nuestra petición.

 

  1. Es posible que recibimos un código 401, y veamos una salida similar a la siguiente:

 

  1. En este caso deberemos “Regenerar” el token empleado ya que está caducado.

 

Debemos recordar que estamos usando el endpoint de “Sandbox”. Los resultados devueltos no serán datos reales, incluso pueden ser datos autogenerados (como en nuestra API de pruebas) con el único objetivo de poder probar la API.

Con esto habremos podido comprobar el funcionamiento de uno de los recursos de la API. Naturalmente podemos seguir navegando por el resto de recursos y cumplimentando los parámetros con los datos que se requieran.

De esta forma podemos aprender y entender el funcionamiento de la API directamente en el API Store de Nubentos, antes de escribir una sola línea de código en nuestro 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