Programación REST

Descripción general#

Portal Carat dispone de dos interfaces de integración con la tienda online, POST / HTML y Web Services (REST), permitiendo la forma adecuada de interacción entre la tienda y Portal Carat, dependiendo del idioma y plataforma de ejecución de la tienda online.

En la interfaz REST, la recogida de datos de la tarjeta y del pago la realizará la Tienda Virtual y Portal Carat solo será responsable de realizar el pago con la entidad financiera.

En esta interfaz, los pagos con tarjeta de crédito, débito o cupón están disponibles. Para pagos a través de banco, como transferencia bancaria, comprobante bancario, utilice la interfaz POST / HTML .

También está disponible en esta interfaz la funcionalidad de programación de pagos recurrentes.

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

Comunicación#

Para realizar una transacción de servicio web, todas las comunicaciones se realizarán a través de HTTPS / SSL. Es importante que el servidor del comerciante admita un cifrado de al menos 128 bits. El servidor de la tienda debe realizar llamadas a direcciones específicas para transacciones REST.

Se debe llamar a cada servicio utilizando la URL base concatenada del recurso deseado (consulte el capítulo sobre el servicio que se va a consumir). El método HTTP (GET, POST o PUT) indica la acción esperada en el recurso elegido. A continuación se muestran las 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

Todas las llamadas realizadas a los servicios serán respondidas sincrónicamente .

Atención:
Nunca use la IP en lugar del dominio esitef-ec.softwareexpress.com.br. La IP puede cambiar en cualquier momento y sin previo aviso, por lo que es importante utilizar el dominio para acceder a Portal Carat. Importante:
Además de los parámetros de devolución del servicio descritos en esta especificación, Portal Carat puede devolver otros parámetros sin previo aviso.
Es importante que la aplicación esté preparada para recibir los parámetros desconocidos además de los parámetros ya especificados y simplemente ignorarlos.

Flujo#

Es posible programar transacciones recurrentes con o sin pago inmediato. En el caso de programación con pago, Portal Carat garantiza la atomicidad de la operación, es decir, la programación solo se activará si se confirma el pago.

Programación con pago inmediato#

! [] (assets / schedule-rest-flow-with-payment.png)

Descripción del flujo:

El comerciante crea una transacción en Pagamento Online, pasa los datos de pago y programación y obtiene un NIT (número de identificación de la transacción) en respuesta. El mero hecho de que se envíen los datos de programación ya se interpretará como un pago a tiempo.
La tienda virtual luego procede a consumir el servicio de procesamiento de pagos, pasando el NIT y los datos de la tarjeta del comprador. En caso de éxito, la transacción de pago cambiará su estado a "CON" (confirmado) y la transacción de programación asumirá el estado de "ATV" (activo).

También es posible realizar un pago con cita previa con confirmación tardía. El flujo a seguir es el mismo que un pago simple con confirmación tardía. [Más información] (pagamento-rest-fluxo.md#pagamento-com-confirmacão-tardia)

Programación sin pago inmediato#

! [] (assets / schedule-rest-flow-no-payment.png)