Gerenciar microsserviços

A área de Microsserviços permite habilitar e gerenciar recursos adicionais disponíveis para utilização com a API E-commerce Cielo.

Os seguintes microsserviços estão disponíveis:

ℹ️
Permissões necessárias
As 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.

Como acessar

No Site Cielo:

Selecione o estabelecimento (EC) desejado;
No menu superior, clique em E-commerce;
Acesse Gestão API E-commerce;
Clique na aba Microsserviços.

Consulta BIN

O microsserviço Consulta BIN permite consultar informações dos cartões a partir do BIN informado.

Habilitar

Para habilitar o serviço:

Localize Consulta BIN;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Continuar;
Conclua a autenticação da operação via aplicativo Cielo Gestão.

Desabilitar

Para desabilitar o serviço:

Localize Consulta BIN;
Desative a chave do microsserviço;
Clique em Desativar para confirmar a operação;
Conclua a autenticação da operação via aplicativo Cielo Gestão.

⚠️
Atenção
Após a desativação, as operações realizadas durante o período em que o microsserviço estiver desabilitado não serão contempladas pela funcionalidade.

Cartão Protegido

O microsserviço Cartão Protegido permite armazenar e acessar dados de cartões tokenizados por meio do Cofre Cielo.

Habilitar

Para habilitar o serviço:

Localize Cartão Protegido;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Gerar Client Secret para gerar as credenciais;
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão;
Copie e armazene as credenciais geradas.

Após a conclusão da autenticação, o sistema exibirá as credenciais geradas para utilização no microsserviço.

Armazene o Client ID e o Client Secret em um ambiente seguro.

Nova credencial

Após a habilitação do microsserviço, a opção Nova credencial ficará disponível em Cartão Protegido.

Ao gerar uma nova credencial, um novo Client Secret será disponibilizado para uso no serviço.

Ao gerar uma nova credencial, a chave atual será automaticamente invalidada.

📘
Credenciais do microsserviço
As credenciais do Cartão Protegido também podem ser gerenciadas pela área Credenciais da Gestão API E-commerce.

Consultar ID do Cofre

Após a habilitação do microsserviço, a opção de consulta ficará disponível por meio do ícone de engrenagem ().

Nessa área, é possível consultar o ID do Cofre vinculado ao estabelecimento.

Desabilitar

A desabilitação do Cartão Protegido deve ser realizada por meio do Atendimento E-commerce Cielo.

Silent Order Post

O Silent Order Post permite capturar dados do cartão utilizando os recursos disponibilizados pela Cielo.

Habilitar

Para habilitar o serviço:

Localize Silent Order Post;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Gerar chave para gerar as credenciais do Silent Order Post (Client ID e Client Secret);
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão;
Copie e armazene as credenciais geradas.

Após a conclusão da autenticação, o sistema exibirá as credenciais geradas para uso no microsserviço.

Armazene o Client ID e o Client Secret em um ambiente seguro.

Nova credencial

Após a habilitação do microsserviço, a opção Nova credencial ficará disponível em Silent Order Post.

Ao gerar uma nova credencial, um novo Client Secret será disponibilizado para uso no serviço.

Ao gerar uma nova credencial, a chave atual será automaticamente invalidada.

ℹ️
Importante
As credenciais do Silent Order Post também podem ser gerenciadas pela área Credenciais da Gestão API E-commerce.

Desabilitar

A desabilitação do Silent Order Post deve ser realizada por meio do Atendimento E-commerce Cielo.

Recorrência Programada

O microsserviço Recorrência Programada permite gerenciar cobranças recorrentes utilizando os recursos disponibilizados pela API E-commerce Cielo.

Habilitar

Para habilitar o serviço:

Localize Recorrência Programada;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Continuar;
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão.

Configurar

Após a habilitação, a opção de configuração ficará disponível por meio do ícone de engrenagem ().

Na tela de configuração, é possível definir as regras de retentativas automáticas das transações.

As seguintes opções estão disponíveis:

Número de tentativas: define a quantidade máxima de retentativas automáticas para uma transação;
Intervalo de dias: define o intervalo entre cada tentativa realizada;
Desabilitar após tentativas esgotadas: encerra automaticamente a recorrência quando todas as tentativas configuradas forem esgotadas.

Após definir as configurações desejadas, clique em Salvar.

Desabilitar

Para desabilitar o serviço:

Localize Recorrência Programada;
Desative a chave do microsserviço;
Clique em Desabilitar para confirmar a operação;
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão.

3DS

O microsserviço 3DS adiciona uma camada adicional de autenticação para transações realizadas com cartão.

Habilitar

Para habilitar o serviço:

Localize 3DS;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Gerar chave para gerar as credenciais Client ID e Client Secret;
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão;
Copie e armazene a credencial gerada.

Após a conclusão da autenticação, o sistema exibirá a credencial gerada para utilização.

ℹ️
Importante
Armazene as credenciais geradas em um ambiente seguro.

Nova credencial

Após a habilitação, a opção Nova credencial ficará disponível em 3DS.

Ao selecionar essa opção, novas credenciais Client ID e Client Secret serão geradas para uso no serviço.

Ao gerar uma nova credencial, a chave atual será automaticamente invalidada.

ℹ️
Importante
As credenciais do 3DS também podem ser gerenciadas pela área Credenciais da Gestão API E-commerce.

Desabilitar

A desabilitação do 3DS deve ser realizada por meio do Atendimento E-commerce Cielo.

Zero Auth

O microsserviço Zero Auth permite validar cartões sem realizar uma autorização financeira.

Habilitar

Para habilitar o serviço:

Localize o Zero Auth;
Ative a chave do microsserviço;
Leia e aceite o termo de uso;
Clique em Continuar;
Conclua a autenticação da operação via aplicativo Cielo Gestão.

Após a conclusão da autenticação, a configuração será processada e aplicada ao microsserviço.

Desabilitar

Para desabilitar o serviço:

Localize o Zero Auth;
Desative a chave do microsserviço;
Clique em Desativar para confirmar a operação;
Conclua a autenticação da operação por meio do aplicativo Cielo Gestão.

ℹ️
Importante
A opção de habilitação do Zero Auth pode não estar disponível para todos os estabelecimentos.
Caso o microsserviço não esteja disponível no Site Cielo, entre em contato com o Atendimento E-commerce Cielo.

Histórico de ações

As alterações realizadas nos microsserviços podem ser consultadas por meio do Histórico de ações da Gestão API E-commerce.

Para mais informações, consulte Histórico de ações.