RetailForce Cloud API

La RetailForce Cloud API expone todas las funcionalidades del RetailForce Cloud Portal. Puede emplearse para automatizar procesos o para invocar funciones desde sistemas externos sin necesidad de autenticarse en el portal ni ejecutar tareas de forma manual.

Autenticación

Para utilizar las funciones, el sistema solicitante debe autenticarse en el sistema Cloud. A continuación se describe la autenticación manual, así como ejemplos de llamadas impulsadas por eventos.

Acceso a través de api.retailForce.cloud

La Cloud API está disponible en la siguiente URL:

• https://api.retailforce.cloud/swagger/index.html

Autenticación manual

La autenticación se realiza mediante cloudApiKey y cloudApiSecret, así como mediante la generación de un token «Bearer».

1. Punto de conexión

1. Haga clic en el punto final POST /api/v1.0/authenticate/logon para desplegar la sección.
2. Introduzca su apiKey y su apiKeySecret en los campos correspondientes.
3. Ejecute la solicitud para recibir un token «Bearer».

2. Utilice el token «Bearer»

1. Copie el token «Bearer» del «ResponseBody».
2. Haga clic en el botón «Autorizar» situado en la parte superior derecha de la Swagger UI.
3. Introduzca el token «Bearer» en el cuadro de diálogo. Formato: Bearer <token> (introduzca un espacio después de «Bearer»).
4. Haga clic en «Autorizar».

Autenticación automática

La autenticación automática permite a los sistemas acceder de forma segura a la RetailForce Cloud API sin necesidad de intervención por parte del usuario, lo que resulta ideal para servicios en segundo plano, flujos de trabajo automatizados o consultas de datos periódicas.

1. Autenticación y obtención del token «Bearer»:

Envíe una solicitud POST con sus credenciales de la API al punto final de autenticación.

curl -X POST "https://api.retailforce.cloud/api/v1.0/authenticate/logon" \
-H "Content-Type: multipart/form-data" \
-F "key=cloudApiKey" \
-F "secret=cloudApiSecret"

Una vez completada con éxito la autenticación, recibirá un token «Bearer» en el ResponseBody, necesario para autorizar futuras solicitudes a la API.

2. Acceso a los puntos finales:

Utilice el token «Bearer» recibido para acceder a los puntos finales.

Ejemplo:

curl -X 'GET' \
'https://api.retailforce.cloud/api/v1.0/someEndpoint' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {yourBearerToken}'

Importante: Mantenga sus credenciales de la API y sus tokens a buen recaudo para evitar el acceso no autorizado.

Fiscalización en la nube

«Fiscalización en la nube» hace referencia a la prestación del middleware de fiscalización de RetailForce como servicio alojado en la nube. El servicio es gestionado por RetailForce en el entorno de la nube.

Acceda a través de fiscalisation.retailforce.cloud

Acceda al servicio a través del siguiente enlace:

• https://fiscalisation.retailforce.cloud/swagger/index.html

Autenticación manual

Existen dos opciones para autenticarse en la fiscalización en la RetailForce Cloud a través de la Swagger UI:

1. Abra la Swagger UI y haga clic en «Autorizar».
2. Métodos de autenticación
   1. Credenciales del portal (correo electrónico y contraseña):
      • Permite el acceso a varias organizaciones.
   2. Clave y secreto de API:
      • Normalmente están vinculadas a un distribuidor u organización concretos.
3. Haga clic en «Autorizar»

Una vez completado este proceso, el sistema le autorizará para iniciar las pruebas y la implementación de la fiscalización en la Cloud.

Este artículo ha sido traducido automáticamente.