Api Cielo Ecommerce NodeJS

Integração com a API Cielo eCommerce da Cielo - https://developercielo.github.io/manual/cielo-ecommerce.

Sobre o projeto   |    Tecnologias   |    Começando   |    Para contribuir   |    Licença

ℹ️ Sobre o projeto

Integração com a API Cielo eCommerce da Cielo, com as funcionalidades e métodos para realizar uma transação.  Requisição utilizando o método POST para o recurso Payment, conforme o exemplo. Esse exemplo contempla o mínimo de campos necessários a serem enviados para a autorização (https://developercielo.github.io/manual/cielo-ecommerce#transa%C3%A7%C3%A3o-simples):

• Atenção: Não é possivel realizar uma transação com valor (Amount) 0.;
• Atenção: Deve-se Utilizar no header da requisição o Content-Type application/json.;

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantId	Guid	36	Sim	Identificador da loja na Cielo.
MerchantKey	Texto	40	Sim	Chave Publica para Autenticação Dupla na Cielo.
Content-Type	Header	40	Sim	application/json (obrigatório o envio deste).
RequestId	Guid	36	Não	Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId	Texto	50	Sim	Numero de identificação do Pedido.
Customer.Name	Texto	255	Não	Nome do Comprador.
Payment.Type	Texto	100	Sim	Tipo do Meio de Pagamento.
Payment.Amount	Número	15	Sim	Valor do Pedido (ser enviado em centavos).
Payment.Installments	Número	2	Sim	Número de Parcelas.
Payment.SoftDescriptor	Texto	13	Não	Texto impresso na fatura bancaria comprador - Exclusivo para VISA/MASTER - não permite caracteres especiais - Ver Anexo
Payment.IsCryptocurrencyNegotiation	Booleano	-	Não (default false)	Deve ser enviado com valor “true” caso se trate de uma transação de compra ou venda de Criptomoeda
CreditCard.CardNumber	Texto	19	Sim	Número do Cartão do Comprador.
CreditCard.Holder	Texto	25	Não	Nome do Comprador impresso no cartão.
CreditCard.ExpirationDate	Texto	7	Sim	Data de validade impresso no cartão.
CreditCard.SecurityCode	Texto	4	Não	Código de segurança impresso no verso do cartão - Ver Anexo.
CreditCard.Brand	Texto	10	Sim	Bandeira do cartão (Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover / Hipercard / Hiper).
CreditCard.CardOnFile.Usage	Texto	-	Não	First se o cartão foi armazenado e é seu primeiro uso. Used se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação
CreditCard.CardOnFile.Reason	Texto	-	Condicional	Indica o propósito de armazenamento de cartões, caso o campo “Usage” for “Used”. Recurring - Compra recorrente programada (ex. assinaturas) Unscheduled - Compra recorrente sem agendamento (ex. aplicativos de serviços) Installments - Parcelamento através da recorrência Veja Mais

🚀 Tecnologias

Technologies that I used to develop this api

• Node.js
• Express
• Nodemon
• Axios
• Eslint
• Prettier
• EditorConfig

💻 Começando

Importe o arquivo Insomnia.json em sua aplicação Insomnia ou clique em Run in Insomnia button

Requerimentos

• Node.js
• Yarn or npm

Clone o projeto e acesse a pasta

$ git clone https://github.com/vilmarsitiodigital/api-cielo-ecommerce.git && cd api-cielo-ecommerce

Siga o passo a passo abaixo

# Instale as dependências
$ yarn

# Para finalizar, execute sua aplicação
$ yarn dev

# Muito bem, o projeto foi iniciado!

🤔 Para contribuir

Faça um fork deste repositório

# Fork usando a linha de comando oficial do GitHub
# Se você não tiver a CLI do GitHub, use o site para fazer isso.

$ gh repo fork vilmarsitiodigital/api-cielo-ecommerce

Siga o passo a passo abaixo

# Clone seu fork
$ git clone your-fork-url && cd api-cielo-ecommerce

# Crie um branch com seu recurso
$ git checkout -b my-feature

# Faça o commit com suas alterações
$ git commit -m 'Feature: My new feature'

# Envie o código para seu remote branch
$ git push origin my-feature

Depois que sua solicitação pull for mesclada, você pode excluir seu branch

📝 Licença

Este projeto está licenciado sob a Licença MIT - consulte a LICENÇA para mais detalhes.

---

Feito com 💚 por Vilmar Batista 🤝 Veja meu linkedin