Uso e invocación del API REST de Gestión

La consola Web de configuración de Sofía2 dispone de un API Rest de configuración que implementa las acciones que se permiten realizar desde la consola web utilizando un interfaz RES.

Para ello se puede utilizar el interfaz que proporciona la consola. Tras logarse en la misma e y pulsar sobre la opción documentación REST de la cabecera, se accederá a una pantalla que presenta el siguiente aspecto:

En el lateral izquierdo se dispondrá de un listado de todos los servicios REST asociados a entidades de la plataforma que se encuentran disponibilizados. Si se desciende en la pantalla, también se podrá acceder a los distintos objetos que los representan:

Si se pulsa sobre alguno de los objetos disponibles, aparecerá la descripción detallada del mismo en el panel principal de la pantalla, por ejemplo para Assets:

Para invocar a uno de los servicios, se pulsará sobre el servicio correspondiente. Aparecerán a la derecha el listado de operaciones disponibles:

Si se pulsa sobre una de ellas, se desplegará la documentación disponible, incluyendo parámetros,…

En la parte derecha de la pantalla, aparecerá un nuevo panel, que permitirá introducir los parámetros necesarios para la invocación del servicio. Para este caso:

Al encontrarnos registrados en la consola web, no será necesario introducir los encabezados (el navegador lo hará de forma automática). Sólo será necesario introducir los distintos parámetros de invocación.

Si se realiza una operación que necesita el envío de información (un alta o modificación por ejemplo), la pantalla proporcionará los interfaces asociados:

Una vez introducidos los datos y seleccionadas las opciones deseadas, al enviar la petición se observará el resultado en la parte inferior derecha de la pantalla. Por ejemplo para la invocación de un método que recupera todas las ontologías:

Las APIS son accesibles también a través de cualquier cliente REST externo. Para ello, habrá que especificar los mismos encabezados y parámetros que en el interfaz que se ha visto. Utilizando el plugin de Chrome “Advanced Rest Client”, una invocación sería similar a:

Se indicaría:

· El host y el puerto

· La ruta del servicio

· Query Parameters a utilizar (parámetros de la invocación)

· Tipo de Operación HTTP

· Encabezados de la petición:

o Tipo de datos que acepta el servicio (en este caso application/json)

o Token de Autorización: Basic (usuario:contraseña en B64)

Tras la invocación al mismo, se obtendría el resultado de igual forma:

Uso e invocación del API REST de Gestión

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s