ApiRest

Prueba de Conexión

Una vez que se cuente con la url destinada al servicio procederemos a probarla. Para ello utilizaremos Postman, SoapUI o algún otro herramienta similar.

Vamos a consultar el EP (End Point) /test. Si el servicio se encuentra activo se mostrará el siguiente mensaje:

Login con Token

El primer End Point a utilizar es el /login/ con el usuario y contraseña generado para el servicio. 

El body a enviar tiene el siguiente formato: 

{"username":"apiuser","password": "apipass"}

Una vez hecho esto generará un token que debe ser enviado siempre en el HEADER de los EP a consultar.

End Points

En primer lugar, en toda fuente de sistema que tiene habilitado el servicio, existe una carpeta llamada api_rest en donde se deberán crear los archivos php de acuerdo a los End Points que se necesiten.

Una vez creado el archivo tienen que solicitar al coordinador del proyecto que incluya el archivo creado en el index de la api rest.

El End Point posee la siguiente estructura.

Se debe crear un nombre de referencia al end point. Dentro del mismo se chequea que el token sea válido y que el formato del body sea el correcto.

Si todo esta correcto, se recuperan las variables enviadas en el body.

Luego se procede a realizar la acción requerida (validaciones, select, insert, etc) devolviendo un array.

Como testear los EP

Para testear los EP se puede descargar el siguiente software https://www.soapui.org/downloads/soapui/

El EP login debe ser llamada cada vez que el token este vencido. El metodo devuelve la información para llamar a los siguientes EP

Los demas EP deben ser llamados con los parametros en el Header con formato JSON más el token generado con el EP login