O Cielo OAUTH é um processo de autenticação das APIs Cielo relacionadas ao e-commerce.
O Cielo OAUTH usa como segurança o protocolo OAUTH2, no qual é necessário primeiro obter um token de acesso utilizando suas credenciais e, posteriormente, informar o token nas requisições às APIs.
Para utilizar o Cielo OAUTH são necessárias as seguintes credenciais:
| CREDENCIAL | DESCRIÇÃO | TIPO |
|---|---|---|
ClientId | Identificador chave fornecido pela Cielo. | GUID |
ClientSecret | Chave que valida o ClientID. Fornecida pela Cielo junto ao ClientID | string |
Para gerar o
ClientIDe oClientSecret, consulte o tópico de Obtendo as Credenciais, a seguir.
Permissões necessáriasAs configurações indicadas só podem ser realizadas por usuários com permissões de Administrador ou Analista.
Para gerenciar permissões de acesso, acesse Meu cadastro > Gestão de acessos.
Obtendo as credenciais ClientId e ClientSecret
Para obter as credenciais ClientId e ClientSecret para autenticação na API do Link de Pagamento ou na API do Checkout, siga os passos a seguir:
- Após receber o nº de estabelecimento (EC) com a habilitação para o Link de Pagamento ou para o Checkout Cielo, acesse o site Cielo e faça o login;
- No menu principal, clique em E-commerce > Link de Pagamento > Configurações > Credenciais de API
- Clique em Gerar novas credenciais;
- Leia a mensagem de confirmação e clique em Gerar;
-
Insira o token de segurança gerado no App Cielo Gestão e clique em Validar;
-
Visualize ou copie o Client ID e o Client Secret exibidos na tela.
- A partir das credenciais, será possível gerar um token de acesso.
ImportanteAs credenciais são exibidas apenas uma vez. Antes de fechar a janela, visualize ou copie o Client ID e o Client Secret e armazene-os em um local seguro.
Após o fechamento da janela, não será mais possível visualizar essas credenciais novamente. Caso necessário, gere novas credenciais.
Ao gerar novas credenciais, as credenciais atuais são invalidadas imediatamente. Atualize sua aplicação com as novas credenciais para manter a comunicação ativa.
Atenção:
- Os dados de contato técnico não são mais utilizados para o envio de chaves, devido a questões de segurança;
- Para alguns cadastros de Link de Pagamento, o uso do Link via API não será permitido por motivos de regras de negócio. Nesses casos, o botão “Gerar Credenciais de Acesso às APIs” não estará disponível no site da Cielo. Se tiver dúvidas sobre como proceder, entre em contato com o suporte de e-commerce;
- Caso você já tenha utilizado uma credencial anterior, ela deixará de funcionar assim que você clicar para gerar novas credenciais.