Autenticação e credenciais

Aqui, você encontra todas as informações necessárias sobre autenticação e ambientes da API Cielo Conecta.

Ambientes: Sandbox, Homologação e Produção

Você pode utilizar o ambiente Sandbox para realizar testes com a API do Cielo Conecta. Para obter uma credencial de homologação e realizar testes, entre em contato com o nosso time de suporte pelo e-mail [email protected].

Já o ambiente de Produção é integrado ao sistema da Cielo, sendo utilizado para operações reais.

A credencial para o ambiente de Produção, composta pelo ClientId e ClientSecret, será disponibilizada após a conclusão do desenvolvimento e homologação da integração.

Credenciais

A autenticação é o primeiro passo para usar as APIs do Cielo Conecta. Ela serve para garantir que apenas sistemas autorizados possam fazer chamadas para os serviços da Cielo. Esse processo é indispensável para gerar o token que será usado nas chamadas às APIs.

MétodoAmbienteEndpoint
POSTSandboxhttps://authsandbox.cieloecommerce.cielo.com.br/oauth2/token
POSTHomologaçãohttps://authsandbox.cieloecommerce.cielo.com.br/oauth2/token
POSTProduçãohttps://auth.cieloecommerce.cielo.com.br/oauth2/token

O endpoint utilizado para Sandbox e Homologação é o mesmo. Portanto, para direcionar a requisição especificamente para o ambiente de Homologação, é necessário incluir uma informação adicional no header. Para isso, crie uma chave no header com:

  • Nome: Environment
  • Valor: Homologacao15
👍

O Cielo Conecta usa o tipo de autenticação chamado Client Credentials, que é uma das formas do OAuth2.

Credenciais necessárias

  • ClientId: Usuário do cliente
  • ClientSecret: Senha do cliente

Escopos disponíveis

Os escopos definem as permissões do token:

  • PhysicalCieloMaster + CieloApi: Cadastro de lojas e terminais
  • PhysicalCieloTransactional: Transações e consultas
📘

Se nenhum escopo for informado, um escopo padrão será atribuído.

Fluxo de autenticação

Aqui está o passo a passo do fluxo de autenticação:

  1. Você recebe um ClientId e um ClientSecret da Cielo;

  2. Sua aplicação envia esses dados para a Cielo, utilizando a API de autenticação, e solicita um token de acesso;

  3. A Cielo responde com um token, que é uma chave temporária que sua aplicação vai usar para se identificar nas próximas chamadas à API.

📘

O token de homologação tem uma validade limitada de 24 horas enquanto o de produção tem uma validade de 20 minutos.

Criando um token de acesso

Abaixo está o passo a passo para criar o token de acesso para acessar a API Cielo Conecta.

MétodoAmbienteEndpoint
POSTSandboxhttps://authsandbox.cieloecommerce.cielo.com.br/oauth2/token
POSTHomologaçãohttps://authsandbox.cieloecommerce.cielo.com.br/oauth2/token
POSTProduçãohttps://auth.cieloecommerce.cielo.com.br/oauth2/token

Na tabela abaixo, você encontra os parâmetros necessários e seus respectivos valores para montar a requisição corretamente.

KeyValue
AuthorizationUsername{Auth_ClientId}
AuthorizationPassword{Auth_ClientSecret}
HeadersContent-Type text/plain
Bodygrant_type client_credentials
Scope{scope}

Request

curl --location --request POST 'https://authsandbox.cieloecommerce.cielo.com.br/oauth2/token' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic {base64(ClientId:ClientSecret)}' \
--data-urlencode 'grant_type=client_credentials'

Response

{
  "access_token": "{Auth_AccessToken}",
  "token_type": "bearer",
  "expires_in": 86399
}