API REST
- Alfredo Lopez (Unlicensed)
- Mario Morales
API REST
Un servicio REST, y mas propiamente una API REST no es una arquitectura software en si, sino un conjunto de restricciones con las que podemos crear un estilo de arquitectura software, el cual podremos usar para crear aplicaciones web respetando el protocolo HTTP. REST es un modelo orientado a los recursos. Significa que cada URI es una representación de un objeto o recurso. Cada recurso está representado por un URI (Identificador Único de Recurso).
Se puede hacer una Obtención de ese recurso utilizando el método HTTP GET, modificarlo con el método HTTP PUT, crear una nueva representación con HTTP POST y HTTP DELETE para eliminar el método (es decir, hay una interfaz uniforme para acceder al recurso) . A su vez, cada recurso tiene n representaciones posibles que pueden ser XML, JSON, etc. Para el caso de las API REST de SIFCO serán solo en formato JSON por ser el mas flexible y estándar de la industria.
En la actualidad no existe proyecto o aplicación que no disponga de una API REST para la creación de servicios profesionales a partir de ese software. Twitter, YouTube, los sistemas de identificación con Facebook hay cientos de empresas que generan negocios gracias al sistema RESTful y las API's REST. Sin ellas, todo el crecimiento en horizontal en INTERNET sería prácticamente imposible. Esto es así porque REST es el estándar más lógico, eficiente y habitual en la creación de API's para servicios de INTERNET, también llamados Web Services.
Por ello, átono con las necesidades de nuestros clientes y para mejorar la flexibilidad y capacidad de integración con herramientas y plataformas de terceros, SIFCO a decidido desarrollar y publicar un conjunto de API’s, basados en el estándar del sistema RESTful que permitan a nuestros clientes contar con una Interfaz de Programación de Aplicación (API), basada en una estructura uniforme y independiente de la Plataforma o Lenguaje a utilizar, permitiendo acceder a la Base de Datos de SIFCO WEB, a través de los Web Services aquí descritos desde cualquier sistema que permita el uso de las restricciones del sistema RESTful y que soportan los métodos básicos a continuación se describen:
MÉTODOS SOPORTADOS POR LAS API REST DE SIFCO WEB
SIFCO WEB permite el consumo de ciertos Web Services por medio de un sistema RESTful, de forma predeterminada a través métodos básicos descritos a continuación:
GET
Método que permite consultar un objeto o recurso.
POST
Método que permite insertar un nuevo registro en el caso que se llame a un objeto que realice inserciones o realizar una consulta mediante un formulario donde los datos permanecen ocultos y no expuestos en el URL. Evitando su modificación por un usuario malicioso.
PUT
Método que permite la actualización de un registro relacionado a una transacción
DELETE (No disponible)
Método permite la eliminación de un registro relacionado a una transacción
FLUJOGRAMA DE TRABAJO (WORKFLOW) Y RELACIÓN CON LA APLICACIÓN SIFCO WEB.
Es importante tener en cuenta que los Web Services aquí descritos no son capaces de funcionar 100% independiente de la Aplicación SIFCO WEB, por ellos es imprescindible tener acceso a ella con los privilegios necesarios, dado a que muchos de los Flujograma de Trabajos (WORKFLOW) descritos en esta documentación contiene un conjunto de actividades que deben ser realizadas manualmente en la Aplicación SIFCO WEB, adicionalmente parte de la información que se requiere para poder consumir los Web Services aquí descritos requieren un usuario con los privilegios adecuados en la Aplicación SIFCO WEB, para obtenerlos.
Por ello se debe tener la precaución de validar que se cuenta con un usuario con los privilegios adecuados en el Modulo con el que se va a interactuar, para poder realizar los pasos necesarios para obtener la información que se desea (Consumir), sin errores o incongruencias en las solicitudes (request) y respuestas (response).
ESTÁNDAR DE PUBLICACIÓN ESPECIFICACIÓN OPEN API 2.0 (OSA 2.0)
La presente documentación esta elaborada bajo el estándar OPEN API 2.0, basado el la RFC 2119, y un conjunto de recomendaciones de la RFC como lo son MIME Types en la RFC 6838, HTTP Codes en la RFC 7231 y en la IANA Status Code Registry), ademas de utilizar de las herramientas provistas por el proyecto Swagger, que provee un conjunto de herramientas que permita de forma rápida y comprensible el desarrollo de la documentación de una API REST, basado en la especificación Donada por Linux Foundation bajo la iniciativa Open API de 2015, la cual permite crear una interfaz RESTful para desarrollar y consumir fácilmente una API al mapear de manera efectiva todos los recursos y operaciones asociados con ella.
CATEGORIZACIÓN DE WEB SERVICES DISPONIBLE EN SIFCO WEB.
A continuación se describe el conjunto de Web Services disponibles actualmente en SIFCO WEB
Es importante mencionar que los Web Services no son solo procedimientos de manipulación de las tablas, sino que estos poseen todas las funcionalidades del módulo con el que se está interactuando, es decir que todas las validación relacionadas al módulo, serán ejecutadas por el Web Service. Las interacción con el servidor deben ser por medio de formato JSON
PREVIO al consumo de cualquier Web Services, se debe realizar los pasos descritos en la Pagina de Configuración de Seguridad para Acceso Autenticado a los Web Services y verificar que la Aplicación SIFCO WEB tiene al menos un usuario habilitado para acceso vía API REST, y luego para poder obtener el token de acceso a los mismos se deben seguir los pasos descritos en Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services.
(c) 2020 por SIFC.O, S.A.