¶ Uso de swager para probar la API REST de OpenGnsys
La API REST de OpenGnsys está documentada con swager que crea automáticamente un listado de ejemplos de la funciones que nos permiten utilizarlas y nos muestra la orden que debemos usar con curl.
Antes de usar una función hemos de autenticarnos. Para ello vamos a la función/url de login.
En el ejemplo ponemos el usuario por defecto de OpenGnsys.
Al pulsar “Try it” nos muestra el comando que ha utilizado y nos devuelve el token para autenticar las comunicaciones que hagamos con el servidor:
En la parte de arriba de la página pulsaremos “Authorize”, nos aparecerá un formulario donde incluiremos la API KEY que nos ha dado el paso anterior.
A partir de ahora todas las consultas contendrán el token.
Como ejemplo vamos a consultar los repositorios que tiene configurado nuestra unidad organizativa.
En el único campo que pide pondremos el identificador de nuestra unidad organizativa. Al dar a “Try it out” devolverá los repositorios que tenemos dados de alta.
Observamos que en el apartado “Curl” el comando que envía incluye el token de autenticación.
Podemos usar las consultas que muestra directamente en curl añadiendo
-k para que no compruebe el certificado digital del servidor
-A "python-requests/" para emular que quien consulta la url es un agente de python
Por ejemplo:
curl -k -X POST -A "python-requests/" --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: XXXXXXXXX' -d '{ \
"labid": 0, \
"maxtime": 24 \
}' 'https://$SERVER/opengnsys/rest/ous/1/images/11/reserve'