Utilizar las APIs de la plataforma para extraer información

Utilizar las APIs de la plataforma para extraer información Una API, del inglés Application Programming Interface, es un programa que permite a dos aplicaciones distintas comunicarse entre sí e intercambiar datos. Nuestras APIs están diseñadas para conectar sus datos existentes en la plataforma con cualquier aplicación de terceros de su elección que sea capaz de recibir dichos datos. Nuestras APIs son privadas (enterprise APIs). Están protegidas y disponen de una clave de identificación (access_token), proporcionada por un servicio de autenticación y autorización (oauth/token). Nuestro protocolo de comunicación está basado en REST (Representational State Transfer) para ser compatible con las diversas plataformas móviles, ya se trate de una aplicación Windows, Apple o Android. Le recomendamos el uso de la interfaz POSTMAN si desea probar la formulación de sus solicitudes hacia las APIs.

Los datos que puede extraer en GET CATEGORÍAS

• lista de categorías
• detalles de las categorías

PRODUCTOS

• lista de productos
• detalles de los productos

CLIENTES

• lista de clientes
• detalles de los clientes por ID
• detalles de los clientes por correo electrónico

PUNTOS DE VENTA

• lista de puntos de venta
• detalles de un punto de venta por ID
• detalles de las locations por ID de punto de venta
• detalles de los stocks por ID de punto de venta
• detalles de las transacciones por ID de punto de venta

LOCATIONS

• lista de locations
• detalles de las locations

EXPORTACIONES

• exportación de pagos en caja
• exportación de pagos en línea

Los datos que puede inyectar en POST

• crear un cliente
• crear una location

Generar su token en Outils

Clés API Haga clic en Créer des identifiants. Elija el nombre que desea asociar a sus credenciales y haga clic en SAUVEGARDER en la parte inferior derecha. Su ID de cliente y su clave secreta serán generados automáticamente por la plataforma. Aparecerá una notificación verde en la parte superior derecha de la ventana cuando sus claves hayan sido creadas correctamente. Copie su ID de cliente y su clave secreta, ya que los necesitará en el paso 6; este par de credenciales constituye su token.

Acceder a las APIs de su plataforma Por razones de seguridad, el acceso a la documentación de la API no es posible desde el BO. Si necesita utilizar la documentación de la API Rental, le rogamos que abra un ticket al soporte para solicitar sus accesos.

Una vez que tenga acceso a su documentación de la API, configure su access_token a través de /openapi/V1/ Haga clic en el botón "AUTHORIZE". Y pegue el token obtenido en la ventana emergente de autorización global que aparece. Sustituya el client_ID y el client_secret prerellenos por las claves generadas en el paso 4. Ahora ha iniciado sesión y su token se enviará automáticamente para autorizar cada una de sus llamadas.

Ejemplo de llamada a la lista de categorías Abra el menú GET/categories haciendo clic en la flecha del extremo derecho y, a continuación, haga clic en EXECUTE. La respuesta de la API Category List se muestra a continuación. Si lo necesita, puede descargar la respuesta del servidor en formato JSON. En la parte inferior de la respuesta, haga clic en DOWNLOAD para descargar el archivo.

Formato de las respuestas Encontrará el detalle del formato de las respuestas, y en particular las posibles respuestas de error, en la parte inferior de la documentación bajo "SCHEMAS". Si desea utilizar Postman en paralelo, autentíquese también en su aplicación con el mismo access token. Opción 1: Autentíquese con un bearer token en el header. Y por último, pruebe la llamada. Por ejemplo, para la lista de categorías. Atención: se ha establecido un límite de una llamada por segundo para evitar sobrecargas del servidor.

Al añadir su API, puede ver su fecha de expiración.