Operaciones genéricas

Descripción general#

El Portal Carat tiene una interfaz REST para realizar operaciones genéricas. Entender que las "operaciones genéricas" son operaciones exclusivas de ciertos autorizadores y que no encajan con operaciones estandarizadas anteriores.

En esta interfaz REST, considere que cada código de operación depende de datos adicionales para funcionar como se espera. Algunas de estas operaciones requieren un token de autenticidad, que debe generarse para cada llamada a la operación genérica. Para obtener más detalles sobre cada operación genérica, consulte la documentación de enrutamiento configurada para su tienda.

Y para saber más sobre estas nomenclaturas (Bin, Software Express, Carat, e-Sitef) Leer más

Comunicación#

Para realizar una solicitud de servicio web REST de operaciones genéricas, utilice las siguientes URL base de Portal Carat:

URL base de producción: https://esitef-ec.softwareexpress.com.br/e-sitef/api

URL base de Homologación:

https://esitef-homologacao.softwareexpress.com.br/e-sitef/api

Que necesitarás#

  • Una aplicación capaz de recibir llamadas POST HTTPS
  • Registro activo en el ambiente de Portal Carat con la URL del POST de autenticidad (solicite el registro a nuestro equipo de soporte)

Fluir#

Las operaciones genéricas tienen dos flujos que dependen del requisito del token de autenticidad para realizar la operación. ! [] (assets / generic-operation-flow.png)

Descripción del flujo:

  1. El comerciante solicita la generación de un token de autenticidad para operaciones genéricas.
  2. El Portal Carat genera un token de autenticidad internamente
  3. El token de autenticidad generado se envía a la tienda a través de un POST en la URL de autenticidad. La tienda debe almacenar este token.
  4. La tienda utiliza el token de autenticidad generado para realizar una operación genérica.
  5. El Portal Carat valida e inactiva el token de autenticidad antes de realizar la operación solicitada.
  6. El Portal Carat realiza la operación genérica y obtiene los resultados de la operación.
  7. El Portal Carat devuelve el resultado de la operación solicitada.

Obs: Existen operaciones genéricas que no necesitan el token de autenticidad, consulte el ítem correspondiente a la operación utilizada en el enrutamiento de interés para verificar esta necesidad.
En caso de que no se necesite el token de autenticidad, los pasos 1, 2 y 3 del flujo anterior no son necesarios.