Cadastro de Lojas REST

Visão Geral#

Para chamar qualquer serviço do Carat, é necessário antes que o lojista tenha sua loja cadastrada pelas nossas equipes de Suporte e Produção (até mesmo para interagir com a API de cadastro de lojas).

A interface REST de cadastro de lojas do Carat é recomendada quando há uma necessidade frequente de cadastro de novas lojas por parte de um mesmo lojista.

Comunicação#

Para realizar uma transação Web Service, toda a comunicação será realizada via HTTPS/SSL. É importante que o servidor do lojista suporte criptografia com no mínimo 128 bits. O servidor da loja deverá realizar chamadas em endereços específicos para transações REST.

Cada serviço deve ser chamado utilizando a URL base concatenada do recurso desejado (veja o capítulo referente ao serviço a ser consumido). O método HTTP (GET, POST ou PUT) indica a ação esperada sobre o recurso escolhido. Abaixo estão as URLs base do Carat:

URL base de Produção:

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

URL base de Homologação:

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

Todas as chamadas realizadas para os serviços serão respondidas de forma síncrona.

Atenção:

Nunca utilize o IP ao invés do domínio esitef-ec.softwareexpress.com.br. O IP pode mudar a qualquer momento e sem aviso prévio, portanto é importante a utilização do domínio para acesso ao Carat.

Importante:

Além dos parâmetros de retorno dos serviços descritos nesta especificação o Carat poderá devolver outros parâmetros sem aviso prévio.

É importante que o aplicativo esteja preparado para receber os parâmetros desconhecidos além dos parâmetros já especificados e simplesmente desprezá-los.

Fluxos#

Criação de loja#

  • 1. A loja inicia o processo requisitando a geração de um token para acesso à API de cadastro de lojas.
    • 1.1. O Carat faz um POST na URL de autenticidade cadastrada da loja contendo o token.
    • 1.2. A loja virtual responde ao POST com código HTTP 200 OK.
    • 1.3. Com o processo de autenticidade bem-sucedido, o Carat retorna uma resposta de sucesso para a loja.
  • 2. Então, a loja virtual envia a requisição de criação de loja, contendo o token obtido anteriormente.
    • 2.1. O Carat cadastra a loja e retorna uma resposta de sucesso.

Edição de loja#

O fluxo para alteração de uma loja é o mesmo da criação, com a diferença de que o serviço a ser chamado no segundo passo é o de edição de lojas.