Sistema de Intercajas

De WikiCofepres
Revisión del 19:30 19 sep 2017 de Admin (discusión | contribuciones) (APIs REST: EJEMPLO)
Saltar a: navegación, buscar
  1. #OBJETIVO
  2. #APIs REST: EJEMPLO


OBJETIVO

El sistema INTERCAJAS, tiene como principal objetivo la consulta de beneficiarios de los distintos regímenes previsionales que administran las provincias y los municipios que integran el CO.FE.PRE.S, todo ello en el marco de la ley 25.326 con respecto a las formalidades y modalidades que deberán resguardar la información que contenga el proyecto a los fines de la seguridad informática y la protección electrónica de los datos. El sistema referido, permitirá, ingresando la identidad de cualquier beneficiario, determinar si el mismo posee antecedentes previsionales en alguno de los regímenes adheridos al sistema, a fin de informar y constatar situaciones que sirvan para su respectivo análisis.



APIs REST: EJEMPLO

A continuaciòn se adjuntan dos archivos comprimidos apiresejemplo.rar y dbejemplo.rar. El primero consiste en un ejemplo de desarrollo en PHP de una API REST, segun lo propuesto en la actualización del sistema de intercajas. El segundo archvio es el SQL de la base de datos utilizado.

- Archivo:Apirestejemplo.rar

- Archivo:Dbejemplo.rar


En este proyecto se utiliza SLIM (mini framework REST para PHP), Composer (manejador de dependencias), MySQL (motor de base de datos), FluentPDO (manejo de las consultas SQL) y JWT Json Web Token (método de autenticación), Insomnia (aplicación para la prueba de REST).


Estructura de la base de datos

La base de datos ejemplo contiene dos tablas:

- Usuario: empleada para la autenticación. Se envia como parametro email y clave (encriptada en md5).

- Beneficiario: contiene los datos de los beneficiarios.


Estructura del proyecto

- src\settings.php: parámetros de conexion a la base de datos, denominaciòn empleada para el token, etc.

- app\model: se desarrollan las consultas SQL (auth_model.php trabaja con la tabla usuario para la autenticación, y beneficiario_model.php contiene las consultas SQL para la obtención de datos de un beneficiario).


Lista de Recursos (ENDPOINTS)

  1. AUTENTICAR
  2. OBTENER BENEFICIARIO POR CUIL



» POST AUTENTICAR

Imagen.jpg


URL http://localhost/public/auth/autenticar


Parámetros Body

email: micorreoelectronicon@email.com

clave: miclave (md5)


Response Content Type

application/json


Status Codes

Success 200


result: token que se utiliza para invocar a los otros servicios (APP-TOKEN)



Imagen1.jpg


result: null (Credenciales no válidas)



» GET OBTENER BENEFICIARIO POR CUIL


URL http://localhost/public/beneficiario/obtener/{CUIL}

Imagen2.jpg


Parámetros

CUIL: cuil de la persona beneficiaria de quien se desea obtener información


Headers

APP-TOKEN: valor obtenido del servicio rest POST AUTENTICAR


Response Content Type

application/json


Status Codes

Success 200



Campo Tipo Valor
cuil numerico {CUIL} cuil de la persona
numeroDocumento numerico {numeroDocumento} numero de documento de la persona
tipoDocumento numerico {idTipoDocumento} 1=DNI, 2=LC, 3=LE, 4=OTRO
apellidoNombres texto {apellido y nombres} apellido y nombres de la persona
sexo texto {sexo} F= femenino; M= masculino
fechaNacimiento date {fechaNacimiento} aaaa-mm-dd fecha de nacimiento de la persona
beneficios numerico-numerico-date {beneficio} listado de beneficios de la persona En cada caso se detalla tipoBeneficio (1= ; 2= ; 3= ); numeroBeneficio (no es obligatorio); fechaInicio (fecha de inicio del beneficio aaaa-mm-dd)


Success 200

Plantilla:CUIL NO ES BENEFICIARIO DEL ORGANISMO

Imagen4.jpg


Invalid 401

APP-TOKEN INVALIDO o NO DEFINIDO

Imagen6.jpg


Invalid 422

VALOR INVALIDO EN Plantilla:CUIL

Imagen5.jpg