Ya está disponible la API REST de poliwin para desarrolladores. Ahora puedes sincronizar tu software de gestión con nuestra API.
¿Que es una API REST?
Es un conjunto de métodos que permiten la comunicación de datos entre aplicaciones.
Para realizar esta comunicación, la API utiliza diferentes tipos de solicitudes necesarias para la manipulación de datos.
El cliente de una API REST puede ser tanto una aplicación Android, iOS o bien una página web la cual permitirá obtener, crear, modificar y eliminar datos ubicados en un servidor.
Principales tipos de solicitudes
- POST Creación de datos.
- GET Lectura de datos.
- DELETE Eliminación de datos.
- PUT Actualización/Modificación de datos.
Utilización API REST
Podremos importar la url de la API en la aplicación Postman y desde ella realizar las pruebas y test necesarios. Postman es una aplicación que permite testear, consumir y monitorizar pruebas automatizadas, documentarlas, imularlas, etc.
1. Obtener la url API JSON para realizar la importación a postman.
2. Postman > Import > Link > Introducir el link que apunta a getapijson.php > import
3. Una vez descargada a Postman se puede comprovar como aparecen todos los métodos con sus respectivos headers, body...
4. Alternativamente a Postman también se podrá utilizar la api desde la propia url de la API REST. Tal y como se muestra en la siguiente imagen clicando sobre el botón "Try it out".
5. Previamente a la utilización de los diferentes métodos será necesario realizar login con el usuario que se van a realizar las diferentes acciones. Para ello se debe utilizar el método auth/login
Códigos respuesta API
200 Result successful
400 Bad Request
401 User not logged in API
403 User has no permission
409 Duplicate key
500 Problem saving to database