Dispor de variadas formas de pagamento é sempre muito positivo para qualquer tipo de estabelecimento comercial; e no universo digital isso não acontece de maneira diferente. Mas, se você possui uma loja virtual ou um sistema de doação, uma das maneiras de resolver essa questão é com a Cielo API 3.0, que lhe possibilita ter no seu site um gateway de pagamento Cielo. Entretanto, para conseguir desfrutar dessa ferramenta é necessário primeiro conectá-la ao seu sistema. Para isso é necessário usar as credenciais Merchant ID Cielo e Merchant Key; e neste post você vai entender em detalhes como conseguir acessar essas duas credenciais para integrar a Cielo API 3.0 à sua plataforma.
A finalidade maior deste texto é mostrar exatamente como obter as credenciais Merchant ID e Merchant Key dentro do site da Cielo; e isso será feito através de um guia super didático. Contudo, não vamos nos limitar a este tópico. Vamos também aproveitar e esclarecer alguns conceitos importantes, abordaremos a relação das credenciais com outras ferramentas e, se possível, tentaremos distinguir o funcionamento da API em relação a outras soluções de pagamento Cielo. Portanto, siga nesta leitura para descobrir como obter a merchant ID e a merchant Key e compreender outros aspectos da ferramenta Cielo API 3.0.
Continue lendo
O que você vai ler
- O que é a Cielo 3.0?
- Credenciais Merchant ID e Merchant Key
- Credenciais 3DS Client ID e Client Secret
- Como acessar as credenciais Merchant ID e Merchant Key na Cielo 3.0?
- Como acessar as credenciais 3DS Client ID e Client Secret na Cielo 3.0?
- Como inserir as credenciais Merchant ID e Merchant Key no GiveWP?
- Como inserir as credenciais 3DS no GiveWP?
- Diferenças entre o Cielo API 3.0 e o Cielo Checkout
- Soluções para API Cielo 3.0
O que é a API Cielo 3.0?
A Cielo 3.0 é uma API para e-commerce, criada pela Cielo. A API funciona como uma solução para pagamentos digitais em comércios eletrônicos, sistema de doação e outras plataformas. Dito de outra maneira, é uma possibilidade de ter, nos sites ou apps, um ambiente Cielo como mais uma opção para receber os pagamentos das compras ou doações que os clientes realizarem.
Desse modo, se, por exemplo, você possui um negócio online, é possível utilizar essa API da Cielo para instalar no seu site o gateway de pagamento. A partir da instalação deste módulo de pagamento, você pode configurá-lo para permitir aos seus clientes ou doadores concluírem os pagamentos pelo cartão de crédito (à vista ou parcelado), pelo cartão de débito, carteiras digitais e coronavoucher.
O processo é bastante simples: após a escolha do produto, serviço ou doação, os usuários, no momento de realizar o pagamento, encontrarão entre as formas disponíveis no seu site, uma página Cielo por onde eles podem efetuar a transação financeira. Nela, haverá todas as informações e funcionalidades necessárias para que o pagamento seja concretizado.
Contudo, esse sistema só começa a funcionar após todo um processo que vai desde a solicitação dos serviços da API à Cielo, até a integração desses mesmos serviços ao site do seu e-commerce ou sistema de doação; através da instalação e configuração do plugin Cielo API 3.0.
Credenciais Merchant ID e Merchant Key
Após abrir a conta na CIELO o acesso as credenciais é disponibilizado, elas são, por assim dizer, códigos ou chaves com as quais você vai conseguir configurar a ferramenta Cielo 3.0. Em outras palavras, é através dessas duas credenciais que se realiza a integração entre a API Cielo 3.0 e o seu e-commerce.
Qual a função dessas credenciais?
Como falamos acima, a finalidade do uso das credenciais é interligar API da Cielo com o seu site, usando-a como página de recebimento de pagamento ou doações por cartão de crédito. Mas, sejamos mais específicos e entendamos o que realmente faz cada uma dessas credenciais.
Credenciais Merchant ID e Merchant Key
As credenciais são, por assim dizer, códigos ou chaves com as quais você vai conseguir configurar a ferramenta Cielo 3.0. Em outras palavras, é através dessas duas credenciais que se realiza a integração entre a API Cielo 3.0 e o seu e-commerce.
Merchant ID Cielo
Primeiramente, vamos tratar do Merchant ID Cielo. Este, como é possível perceber pela expressão “ID”, é um código identificador (no formato GUID).Sua função é identificar a loja virtual nas operações ligadas à Cielo; tal como o número de uma casa serve para identificá-la e distingui-las das demais em uma rua.
Ele é muito útil, por exemplo, quando a própria API precisa encontrar o seu e-commerce para realizar alguma solicitação ou se você precisar preencher algum formulário de solicitação à Cielo em que é necessário dizer quem é o solicitante.
Merchant Key Cielo
Já no caso da merchant Key, o conceito é bem mais simples. Trata-se de um código que funciona como uma chave de segurança da API Cielo. E Obviamente, por ser uma chave de segurança, não deve ser compartilhada com terceiros.
Como acessar as credenciais Merchant ID e Merchant Key na Cielo 3.0?
Ao abrir uma conta na Cielo e realizar a confirmação do cadastro no e-commerce API Cielo 3.0, você receberá um e-mail de boas vindas com um link para entrar no estabelecimento e acessar as credenciais Merchant ID Cielo e Merchant Key.
Por isso, a fim de que você conheça exatamente o caminho para chegar às credenciais de produção da sua loja virtual, preparamos este pequeno guia, que vai ajudá-lo neste problema. Siga as instruções abaixo para obter a sua Merchant ID e a Merchant Key:
- Primeiramente, clique no link, presente no e-mail de boas vindas, para acessar a página da Cielo e entrar na sua conta.
- Na página da Cielo, clique no botão Acessar minha conta e insira os seus dados de login para entrar no seu perfil.
- Já no seu perfil da Cielo, acesse o menu superior e clique na opção E-commerce.
- Dentro da página de e-commerce, vá até a seção Gestão API e-commerce e clique no botão Acessar.
- Em seguida, você será redirecionado à página do API e-Commerce. Dentro dela, no menu azul, clique em Credencial API.
- Se ainda não tem a credencial, clique no botão para gerar a credencial. Nessa página apenas o MerchantID fica vísivel o MerchantKey ele é mostrado apenas uma única vez quando é gerado. Caso não tenha anotado ou não saiba clique no botão “Revogar credencial” para criar uma nova MerchantKey.
- Logo em seguida será aberta uma página contendo o Merchant Key. Importante: No processo de revogação de uma credencial, uma nova é automaticamente criada para manter a funcionalidade. Ao revogar, é necessário aguardar cerca de 15 minutos para a atualização dos dados da nova chave ser exibida na tela e para um novo pedido de revogação.
Para chegar à Merchant Key você deve sempre realizar esse passo a passo. No entanto, você pode também copiar as duas credenciais e salvá-las em algum outro local seguro para tê-las sempre em mãos mais rapidamente.
Como inserir as credenciais Merchant ID e Merchant Key no GiveWP?
A inserção do Merchant ID Cielo e da Merchant Key no GiveWP faz parte do processo de configuração do plugin Cielo API 3.0, pelo GiveWP e dentro do painel WordPress. Na verdade, é neste momento que de fato acontece a integração entre o seu site e o ambiente de pagamentos Cielo.
Por isso, este tópico é dedicado a ensinar como chegar à página onde as duas credenciais são exigidas. Esta é uma das etapas do processo e sem passar por ela, não é possível usar a Cielo 3.0 como um gateway de pagamento. Portanto, agora que você já sabe como obter as credenciais, vejamos como inseri-las no GiveWP.
- Antes de tudo, o primeiro passo é fazer a instalação e ativação do plugin Cielo API 3.0 no WordPress;
- Em seguida, no item Doações do menu lateral do WordPress, acesse o subitem Configurações;
- Na página de configurações, entre na seção Gateways de pagamentos;
- Dentro da página Gateways de pagamento clique em Cielo API 3.0, nela será realizada a integração;
- Imediatamente uma nova página carregará com vários formulários a serem preenchidos; entre os quais estarão os campos Merchant ID e Merchant Key.
Como inserir as credenciais Merchant ID e Merchant Key no WooCommerce?
O plugin da CIELO para WooCommerce é uma solução eficiente para recebimentos via PIX, cartão de crédito e débito em lojas virtuais com WooCommerce.
Para configurar as chaves da CIELO no WooCommerce, acesse as configurações de Meios de Pagamento dentro do WooCommerce.
Para mais detalhes sobre o processo de configuração, consulte nosso guia completo: 👉 Configuração da CIELO no WooCommerce.
Credenciais 3DS: ClientID e ClientSecret
As chaves 3DS (3D Secure) da Cielo são ferramentas de segurança utilizadas em transações online para proteger tanto o cliente quanto o lojista contra fraudes. Elas fazem parte do protocolo 3D Secure, que adiciona uma etapa de autenticação no momento do pagamento.
O que é autenticação 3DS?
É um protocolo de autenticação que confirma se o comprador é de fato o portador do cartão (de crédito ou débito). O objetivo do 3DS (também chamado de EMV 3DS) é evitar fraudes em transações de cartão não presente (CNP). Por meio do 3DS, os dados do comprador são enviados para as bandeiras e emissores do cartão, que irão realizar a autenticação.
O que significa 3DS?
3DS significa 3-D Secure Protocol e foi desenvolvido pela EMVCo, um corpo técnico formado pelas principais bandeiras de cartão e que cria especificações para a interoperabilidade e aceitação de pagamentos de forma segura no mundo todo.
Ele é muito útil, por exemplo, quando a própria API precisa encontrar o seu e-commerce para realizar alguma solicitação ou se você precisar preencher algum formulário de solicitação à Cielo em que é necessário dizer quem é o solicitante.
Principais benefícios das chaves 3DS:
- A responsabilidade em caso de chargeback de uma transação autenticada é do emissor ou da bandeira;
- Integração facilitada via JavaScript;
- Possibilidade de autenticação silenciosa (autenticação sem desafio);
- Minimiza transações com fraudes
Como acessar as credenciais 3DS: Client ID e Client Secret na Cielo 3.0?
Conheça exatamente o caminho para chegar às credenciais 3DS de produção da sua plataforma de doação ou loja virtual, preparamos este pequeno guia, que vai ajudá-lo neste problema. Siga as instruções abaixo para obter a sua chave ClientID e ClientSecret:
- Já no seu perfil da Cielo, acesse o menu superior e clique na opção E-commerce.
- Dentro de Gestão API E-commerce clique em Acessar
- Ao clicar em Gerar credencial, será necessário selecionar a funcionalidade 3DS, em alguns casos para concluir o processo será necessário se autenticar informando um token. Para conseguir o token, existem duas opções – consultar o app Cielo Gestão ou receber o token por e-mail:
- Caso você tenha acesso ao app Cielo Gestão, acesse a tela de login do seu aplicativo para resgatar o token, cole o token na tela de autenticação do site e clique em Autenticar. Veja como acessar e ativar o token no vídeo Como acessar e ativar o token no App Cielo Gestão
- caso você não tenha cadastro no app Cielo Gestão, o token será enviado ao e-mail cadastrado do site Cielo. Cole o token na tela de autenticação do site e clique em Autenticar:
- Ao inserir o token, as credenciais Client ID e Client Secret serão exibidas:
- Copie o Client ID e Client Secret e cole as credenciais em um local seguro e salve.
Certifique-se de copiar as credenciais 3DS Client ID e Client Secret e armazená-las em um local seguro. Assim, você poderá acessá-las facilmente sempre que necessário.
6. Para configurar o Plugin 3DS, além das credenciais Client ID e Client Secret, será necessário acessar as informações disponíveis na seção Meu Cadastro do painel da Cielo. Esses dados incluem:
- Número do estabelecimento (EC)
- Razão Social
- Ramo de atividade
Certifique-se de obter essas informações diretamente no painel da Cielo, na área Meu Cadastro, para garantir a configuração correta do plugin.
Como inserir as credenciais 3DS Client ID e Client Secret no GiveWP?
A inserção do Client ID e Client Secret no GiveWP faz parte do processo de configuração do plugin 3DS pelo GiveWP e dentro do painel WordPress. Na verdade, é neste momento que de fato acontece a integração entre o seu site e o ambiente de pagamentos Cielo.
Por isso, este tópico é dedicado a ensinar como chegar à página onde as duas credenciais são exigidas. Esta é uma das etapas do processo e sem passar por ela, não é possível usar a Cielo 3.0 como um gateway de pagamento. Portanto, agora que você já sabe como obter as credenciais, vejamos como inseri-las no GiveWP.
- Antes de tudo, o primeiro passo é fazer a instalação e ativação do plugin 3DS no WordPress;
- Em seguida, no item Doações do menu lateral do WordPress, acesse o subitem Configurações;
- Na página de configurações, entre na seção Gateways de pagamentos;
- Dentro da página Gateways de pagamento clique em Cielo Débito 3DS e Cielo Crédito 3DS, nela será realizada a integração;
- Imediatamente uma nova página carregará com vários formulários a serem preenchidos; entre os quais estarão os campos Merchant ID, Merchant Key, Client ID e Client Secret.
Atualmente, existem dois plugins compatíveis com transações 3DS para a CIELO no WordPress: WooCommerce e GiveWP. Confira abaixo nossos plugins.
Diferenças entre o Cielo API 3.0 e o Cielo Checkout
O Cielo Checkout é também uma solução de pagamento, assim como a Cielo API 3.0. E sobre esta última, muito já foi falado ao longo deste post. Ainda assim, é importante retomar o seu conceito e, a partir dele, pontuar as diferenças que existem em relação ao Cielo Checkout .
Vimos que a Cielo API 3.0 é a tecnologia com a qual você consegue ter dentro do seu site uma página da Cielo para pagamentos. E entendendo essa afirmação, já conseguimos também enxergar a distinção essencial entre os dois gateways de pagamento: a API Cielo 3.0 é um ambiente que faz parte do seu site; ou seja, o seu cliente, quando for realizar um pagamento, em nenhum momento sairá do seu domínio para concluir a transação; esse processo recebe o nome de Checkout transparente.
Por outro lado, se você usa o Cielo Checkout, no momento de efetuar um pagamento os usuários deixam temporariamente o seu site e são direcionados a uma página da Cielo (localizada em um domínio pertencente à empresa Cielo); lá a transação é concretizada e repassada, depois, à sua conta.
Uma outra importante diferença que vale ressaltar, é que na utilização do Cielo Checkout, não existe a chave merchant Key, apenas o merchant ID Cielo é disponibilizado. Esta credencial, tal como na Cielo API 3.0, serve como código de identificação da loja virtual, como elemento de autenticação. Ela representa a loja nas operações realizadas no ambiente Cielo.
Soluções para API Cielo 3.0
Agora que você já entendeu o passo a passo para obter as suas credenciais de produção, que tal conhecer as soluções que a Link Nacional oferece em relação ao desenvolvimento de tecnologias de pagamentos voltadas à plataforma Cielo? Temos uma equipe de profissionais experientes, prontos para entender o seu problema e elaborar a melhor solução para ele. Por isso, não perca mais tempo! Contrate agora uma de nossas soluções Cielo ou entre em contato conosco e fale com nossos consultores, que já estão prontos para atender a sua solicitação.
Integração Cielo API 3.0 no GiveWP
Melhore a experiência de doação com pagamentos seguros e parcelamento
excelente trabalho