API Manager: Metodos Custom Query

En la última versión de la plataforma se incorpora una nueva funcionalidad dentro del módulo API Manager: Métodos Custom Query.

El Api Manager es un módulo que surge con la necesidad de aislar a los usuarios de los detalles particulares de la plataforma a la hora de interactuar con la información almacenada en la misma.

Con el fin de facilitar el acceso a dicha información, se ha ampliado la funcionalidad del Api Manager para hacerlo aún más transparente para su uso.

De esta forma, a la hora de disponibilizar una Ontología como API, se podrá definir un nuevo tipo de Operación que se añade a los ya existentes: Custom Query.

Un método Custom Query almacenará todos los detalles de parametrización asociados a la invocación de un método del API al que pertenezca. Se almacenará tanto la consulta a realizar, sus parámetros, así como las opciones genéricas de la operación, como la BD sobre la que se efectúa la consulta, el tipo de consulta y el formato de los resultados obtenidos.

En el interfaz de la consola, a la hora de dar de alta un nuevo API que disponibilice una Ontología, se mostrará la siguiente opción:

Para añadir un nuevo método CUSTOM query, se pulsará sobre dicho botón. Se mostrará el siguiente diálogo:

Se indicará:

· Método de la operación (en este caso sólo GET).

· Nombre de la operación. Servirá para identificarla y permitir su invocación. Debe ser único para cada API.

· Query a ejecutar. Será la query que se efectuará para recuperar los datos. Debe realizarse sobre la ontología que se disponibiliza. Puede incluirse tanto en formato SQLLIKE como NATIVE (seleccionable en el siguiente componente). Además se pueden definir parámetros a aplicar sobre la misma query. Los parámetros se indicaran entre {}. Ejemplos de querys validas son:

select * from sulfato

select * from sulfato where sulfato.Provincia={$provincia}

select * from sulfato where sulfato.Provincia={$provincia} and sulfato.Resultado={$resultado}

db.sulfato.find()

Una vez introducida la query, si se ha definido algún parámetro en la misma, se cargaran en el panel de Parámetros para asociarles un tipo. Los tipos disponibles son STRING, NUMBER y BOOLEAN.

· Query type: Indica si la consulta a efectuar está en formato SQLLIKE o NATIVE.

· Target DB: Selecciona sobre qué BD se realiza la consulta (BDTR o BDH).

· Formato Resultado: Formato en el que se devolverán los datos. Las opciones disponibles son JSON, XML y CSV.

· Descripción: Se incluye una descripción de la operación para facilitar su identificación.

A continuación se incluye un ejemplo de definición de una operación Custom Query:

customquery

Tras pulsar sobre el botón Guardar, se almacenará la nueva Operación:

El comportamiento de la operación será similar a las existentes hasta ahora. Al incluirse en un API, podrá ser invocada por aquellos usuarios que estén suscritos a ella.

El interfaz WEB de invocación mostrará la nueva operación:

Y para su invocación será necesario indicar el token de usuario (como hasta ahora) y los parámetros que se hayan definido en la query. En este caso:

Los parámetros siempre serán obligatorios, ya que se utilizan para ejecutar la query. Si se definen querys sin parámetros (sin condiciones), sólo será necesario introducir el token de usuario.

De esta forma, el usuario que utilice este tipo de operaciones no tendrá que introducir la consulta a ejecutar en cada petición.

Esta funcionalidad se añade a las anteriores, que siguen estando disponibles como hasta ahora.

API Manager: Metodos Custom Query

2 comentarios en “API Manager: Metodos Custom Query

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