API REST API Manager

En la release 2.13 de Sofia2, el módulo API Manager incorpora una nueva interfaz REST para acceder a la gestión de las APIs sin tener que hacer uso de la consola de Configuración.

Si bien es posible invocar los servicios expuestos a través de cualquier servicio externo, también se incorpora un nuevo interfaz gráfico para su utilización.

Como puede observarse, se exponen 3 nuevas APIs: Token Usuario Service, Apis Suscripciones Service y Api Service.

Para facilitar el uso de dichas APIs, el mecanismo de seguridad implementado será mediante la inclusión de un token de usuario en el Header de la petición:

El usuario que invoque a las Apis, debe estar dado de alta en la plataforma Sofia2 y disponer de un token de usuario propio.

A continuación se detalla cada una de las APIs disponibles

  • Token Usuario Service: incorpora los siguientes servicios:

o La operación GET permitirá obtener el token de usuario de un determinado usuario, pasando como parámetro el identificador de usuario.

o La operación POST permitirá generar el token de usuario de un determinado usuario, pasando como parámetro el identificador de usuario.

o La operación PUT permitirá regenerar el token de usuario de un determinado usuario, pasando como parámetro el identificador de usuario.

– Apis Suscripciones Service: Recupera información sobre las suscripciones a las APIs existentes:

o La operación GET (/apisuscripciones/usuario/{identificacionUsuario}) permite recuperar todas las suscripciones de un determinado usuario.

o La operación GET (/apisuscripciones/{identificación}) recupera todas las suscripciones a una determinada API.

o La operación POST permitirá realizar la suscripción de un usuario a una API determinada.

o La operación PUT permitirá modificar una suscripción existente.

o La operación DELETE eliminará la suscripción indicada.

– Api Service: Gestiona información referente a las APIs dadas de alta en el sistema:

  • La operación GET (/apisuscripciones}) recupera todas las APIs con esa identificación (todas las versiones existentes).
  • La operación GET (/apis) permite recuperar todas las Apis filtrando por usuario, identificación y estado.
  • La operación POST permitirá realizar la creación de una nueva API.
  • La operación PUT permite modificar una API existente.
  • La operación DELETE (/apis) eliminará la API indicada.
  • La operación DELETE (/apis/{identificación}/{numversion} eliminará una API utilizando su identificación y numero de versión.

La realización de las operaciones proporcionadas por estos servicios estará supeditada al usuario que los invoquen, comprobando si dicho usuario tiene o no permisos para realizar la operación.

API REST API Manager

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