@vwp/cielo-node

Vwp Cielo API-3.0

SDK API-3.0 Nodejs, inspirado na sdk em PHP

Dependências

• NODEJS >= 6
• NPM >= 5.6.0
• Yarn >= 1.4
• TypeScript >= 2.6.2

Criando um Build

Todo o código fonte encontra-se na pasta src/. Para criar um build rode yarn run tsc e aguarde o compilador. O resultado final entra-se na pasta lib/ gerada pelo TypeScript.

Contribuindo

• Clone o repositório do Repositório Local
• Crie um branch que exemplifique as tarefas que forem ser executadas (ex: feature/query-sale, hotfix/change-payment-status)
• Assim que terminado, faça merge para o branch master usando a flag --no-ff

Test

Tenha em mão o seu MerchantId e MerchantKey para desenvolvedores. Para isso basta acessar o Sandbox Register e fazer um cadastro rápido.

Clone o projeto do servidor local, instale os módulos e divirta-se

yarn run test

npm run test

Grar documentação

Para gerar a documentação, tenha instalado na maquina o Docify:

npm install -g docify

Altere o README.md e rode o comando.

docsify init ./docs

Para ver o resultado inicie o servidor do docify

docsify serve docs

Principais recursos

• [x] Pagamentos por cartão de crédito. (Obrigatório)
• [ ] Pagamentos recorrentes. (Opcional - 2º plano)
  • [ ] Com autorização na primeira recorrência.(Opcional - 2º plano)
  • [ ] Com autorização a partir da primeira recorrência.(Opcional - 2º plano)
• [ ] Pagamentos por cartão de débito.(Opcional - 2º plano)
• [x] Pagamentos por boleto. (Obrigatório)
• [ ] Pagamentos por transferência eletrônica.
• [ ] Cancelamento de autorização. (Obrigatório)
• [x] Consulta de pagamentos. (Obrigatório)
• [ ] Tokenização de cartão.(Opcional - 2º plano)

Limitações

Por envolver a interface de usuário da aplicação, o SDK funciona apenas como um framework para criação das transações. Nos casos onde a autorização é direta, não há limitação; mas nos casos onde é necessário a autenticação ou qualquer tipo de redirecionamento do usuário, o desenvolvedor deverá utilizar o SDK para gerar o pagamento e, com o link retornado pela Cielo, providenciar o redirecionamento do usuário.

Instalando o SDK

Se você já possui um projeto configurado basta adicionar o modulo usando:

Yarn

yarn install @vwp/cielo-node

NPM

yarn install @vwp/cielo-node

Produtos e Bandeiras suportadas e suas constantes

Bandeira	Constante	Crédito à vista	Crédito parcelado Loja	Débito	Voucher
Visa	CreditCard::VISA	Sim	Sim	Sim	Não
Master Card	CreditCard::MASTERCARD	Sim	Sim	Sim	Não
American Express	CreditCard::AMEX	Sim	Sim	Não	Não
Elo	CreditCard::ELO	Sim	Sim	Não	Não
Diners Club	CreditCard::DINERS	Sim	Sim	Não	Não
Discover	CreditCard::DISCOVER	Sim	Não	Não	Não
JCB	CreditCard::JCB	Sim	Sim	Não	Não
Aura	CreditCard::AURA	Sim	Sim	Não	Não

Manual

Para mais informações sobre a integração com a API 3.0 da Cielo, vide o manual em: Integração API 3.0

ÚLTIMOS COMMITS

 Atualizaçao: Adicionado a empresa como autor
Hash: 9bbf0ed
Email: [e-mail]
Name: Washington
Date: 22/02/2019 16 horas 54 minutos 13 segundos

 Atualizaçao: Adicionado a documentaçao
Hash: 94ed6b8
Email: [e-mail]
Name: Washington
Date: 22/02/2019 16 horas 49 minutos 31 segundos

 Versao: homologaçao da versao 1.1.0
Hash: 7a6b283
Email: [e-mail]
Name: Washington
Date: 21/02/2019 18 horas 29 minutos 55 segundos