Operações Genéricas

Visão Geral

O Carat possui uma interface REST para a realização de operações genéricas. Entenda que as "operações genéricas" são operações exclusivas de determinados autorizadoras e que não se adequam ao operações padronizadas anteriores.

Nesta interface REST considere que cada código de operação depende de dados adicionais para que funcione conforme o esperado. Algumas destas operações necessitam de um token de autenticidade, a qual deve ser gerada para cada chamada da operação genérica. Para maiores detalhes de cada operação genérica, veja as documentações do roteamento configurado para sua loja.

E para saber mais sobre essas nomenclaturas (Bin, Software Express, Carat, e-Sitef) Saiba mais

Comunicação

Para realizar uma requisição de web service REST de operações genéricas, utilize as seguintes URLs base do Carat:

URL base de Produção:

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

URL base de Homologação:

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

O que você precisará

• Uma aplicação capaz de receber chamadas POST HTTPS
• Cadastro ativo no ambiente do Carat com a URL para o POST de autenticidade (solicite o cadastro à nossa equipe de suporte)

Fluxo

As operações genéricas possuem dois fluxos que dependem da obrigatoriedade do token de autenticidade para a execução da operação.

Descrição do fluxo:

1. Lojista solicita a geração de um token de autenticidade para as operações genéricas.
2. O Carat gera um token de autenticidade internamente
3. O token de autenticidade gerado é enviado para a loja através de um POST na URL de autenticidade. A loja deve guardar este token.
4. A loja usa o token de autenticidade gerado para realizar uma operação genérica.
5. O Carat valida e inativa o token de autenticidade antes de realizar a operação solicitada.
6. O Carat realiza a operação genérica e obtem os resultados da operação.
7. O Carat retorna o resultado da operação solicitada.

Obs: Existem operações genéricas que não necessitam do token de autenticidade, consulte o item correspondente à operação utilizada no roteamento de interesse para verificar esta necessidade.
No caso do token de autenticidade não ser necessário, os passos 1, 2 e 3 do fluxo acima não são necessários.