Introdução
API
Buscando oferecer uma forma de clientes e integradores visualizar na prática como são emitidas nossas cobranças, oferecemos vários exemplos prontos de integração com as APIs da Efí que demonstram a modalidade de boleto/Bolix, carnê, cartão de crédito, Pix, assinaturas (cobrança recorrente), link de pagamento e Split de pagamento, podendo assim ter uma experiência com os nossos serviços antes de ir para o desenvolvimento.
Além da possibilidade de executar estes testes, deixamos todos os códigos utilizados nestes exemplos disponíveis para download. Vale ressaltar que, nestes exemplos foi utilizado a SDK de PHP para integração com as APIs.
Executar exemplos
Para executar estes exemplos em seu ambiente você precisa criar uma conta Efí e também uma aplicação para obter as credenciais.
Importante!Após baixar estes exemplos, não esqueça de inserir suas credenciais no arquivo credentials.json, sendo elas, o Client_Id e Client_Secret de acordo com o ambiente utilizado (Homologação ou produção), além de lembrar que o parâmetro sandbox é booleano e possui 2 valores possíveis, de acordo com o ambiente, sendo: sandbox => true equivale ao ambiente de Homologação e sandbox => false equivale ao ambiente de Produção.
Para utilizar o exemplo do Pix, deve-se informar também no arquivo credentials.json, no atributo certificate o diretório ./certs/, acrescentando o nome do seu certificado no formato .pem. Aqui você encontra dicas para gerar seu certificado e convertê-lo .p12 para .pem. É necessário também, no arquivo ./pix/emitir_pix.php, na variável $body inserir sua chave pix registrada na Efí no parâmetro "chave" => "".
Para funcionamento dos exemplos que envolvem a emissão de _cartão de crédito_, é necessário que você informe seu identificador de conta na linha 1 do script contido no arquivo ./assets/js/payment-token.js. Script este que é utilizado para obtenção do payment_token. Importante frisar que este código é específico de acordo com o ambiente utilizado (produção ou Homologação). Veja neste link como obter corretamente seu payment_token.
Por se tratar de um exemplo meramente ilustrativo e de cunho educativo, é necessário que você adapte à sua necessidade. Não nos responsabilizamos pela utilização deste exemplo sem os ajustes necessários para seu ambiente de produção.
Lightbox
A integração com o Lightbox da Efí lhe permite exibir o formulário de coleta das informações de pagamento sobreposta à sua página de checkout. Por exemplo, quando o cliente adiciona os produtos no carrinho e fecha o pedido, apenas esmaecemos o fundo do seu site e o comprador visualiza uma nova janela modal para preenchimento dos dados de pagamento.
Como funciona o Lightbox
O Lightbox se comunica com a API da Efí Pay através de um back-end que deve ser desenvolvido utilizando uma de nossas SDKs disponíveis, de acordo com a necessidade e regra de negocio do sistema integrador. Sendo necessário o integrador desenvolver também a solução de retorno das notificações, utilizando da funcionalidade de callback para boleto e cartão, e o webhook para Pix.
Instalação
Para instalar a loja de demonstração do Lightbox, basta clonar o repositório do Github e seguir as intruções de instalação disponível no arquivo README.md.
No código de exemplo que disponibilizamos é possível optar por utilizar o back-end em PHP ou Node.js, as alterações necessárias para a utilização de cada um deles estão descritas no arquivo README.md.