Agendamento REST

Visão Geral

O e-SiTef possui duas interfaces para integração com a loja virtual, POST/HTML e Web Services (REST ou SOAP), possibilitando a maneira adequada de interação da loja com o e-SiTef, conforme a linguagem e plataforma de execução da loja virtual.

Na interface REST, a coleta dos dados do cartão e do pagamento será realizada pela Loja Virtual e o e-SiTef apenas se encarregará de efetuar o pagamento com a instituição financeira.

Nessa interface estão disponíveis os pagamentos com cartão de crédito, débito ou voucher. Para pagamentos via banco como transferência bancária, boleto, utilize a interface POST/HTML.

Também disponível nesta interface está a funcionalidade de agendamento de pagamentos recorrentes.

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 e-SiTef:

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 e-SiTef.

Importante:

Além dos parâmetros de retorno dos serviços descritos nesta especificação o e-SiTef 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.

Fluxo

É possível realizar um agendamento de transações recorrentes com ou sem um pagamento imediato. No caso de agendamento com pagamento, o e-SiTef garante a atomicidade da operação, ou seja, o agendamento só será ativado se o pagamento for confirmado.

Agendamento com pagamento imediato

Descrição do fluxo:

1. O lojista cria uma transação no e-SiTef passando os dados de pagamento e agendamento e obtém como resposta um NIT (número identificador de transação). O simples fato de dados de agendamento serem enviados já será interpretado como um pagamento com agendamento.
2. A loja virtual prossegue então consumindo o serviço de efetivação do pagamento, passando o NIT e os dados do cartão do comprador. Em caso de sucesso, a transação de pagamento mudará seu status para CON (confirmada) e a transação de agendamento assumirá o status ATV (ativa).

Também é possível fazer um pagamento com agendamento com confirmação tardia. O fluxo a ser seguido é o mesmo de um pagamento simples com confirmação tardia. Saiba mais.

Agendamento sem pagamento imediato

Descrição do fluxo:

1. O lojista cria uma transação no e-SiTef passando os dados do agendamento e o parâmetro do_payment_now com valor false. Como resposta, o lojista obterá um SID (identificador de agendamento).
2. A loja virtual prossegue então consumindo o serviço de ativação do agendamento, passando o SID e os dados do cartão do comprador. Em caso de sucesso, o agendamento terá seu status alterado para ATV (ativo).

Consulta dos agendamentos

As informações das transações de agendamento podem ser consultadas através do mesmo serviço utilizado pela interface de Pagamento REST. Saiba mais.