Registro de la tienda REST

Descripción general

Para llamar a cualquier servicio de Portal Carat, es necesario antes de que el comerciante tenga su tienda registrada por nuestros equipos de Soporte y Producción (incluso para interactuar con la API de registro de la tienda).

Se recomienda la interfaz REST para registrar tiendas en Portal Carat cuando existe una necesidad frecuente de registrar nuevas tiendas por parte del mismo comerciante.

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

URLBase de aprobació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.

Flujos

Creación de tienda

• 1. La tienda inicia el proceso solicitando la generación de un token para acceder a la API de registro de la tienda.
  • 1.1. Portal Carat realiza un POST en la URL de autenticidad registrada de la tienda que contiene el token.
  • 1.2. La tienda virtual responde a POST con el código HTTP 200 OK.
  • 1.3. Con el proceso de autenticidad exitoso, Portal Carat devuelve una respuesta exitosa a la tienda.
• 2. Luego, la tienda virtual envía la solicitud de creación de tienda, que contiene el token obtenido anteriormente.
  • 2.1. Portal Carat registra la tienda y devuelve una respuesta exitosa.

Edición de tienda

El flujo para cambiar una tienda es el mismo que para la creación, con la diferencia de que el servicio al que se llamará en el segundo paso es la edición de la tienda.