Cielo OAUTH is an authentication process for Cielo APIs related to e-commerce.
Cielo OAUTH uses the OAUTH2 protocol for security. In it, it is necessary to first obtain an access token using your credentials and then send it to the Transactional Control API.
To use Cielo OAUTH, the following credentials are required:
| CREDENTIAL | DESCRIPTION | TIPO |
|---|---|---|
ClientId | Key identifier provided by Cielo | GUID |
ClientSecret | Key that validates the ClientID. Provided by Cielo along with ClientId | string |
Get credentials
To obtain the ClientId and ClientSecret credentials for authentication to the Payment Link API or Checkout API, follow the steps below:
- After receiving the establishment number (EC) with the authorization for Link de pagamento and Checkout, access the Cielo website and login;
- To access Link de pagamento, navigate to the tab E-commerce > Link de Pagamento > Meus Links > Configurações > Dados Cadastrais. If you are using Checkout, go to the tab E-commerce > Checkout > Acessar > Configurações > Dados Cadastrais.
Following image illustrates the configurações:
Following image illustrates the dados cadastrais:
- In the Dados cadastrais section, click the button Gerar crendenciais de Acesso ás APIs, and a confirmation message will appear on the screen;
- An email will be sent with the keys to the address registered as the store’s responsible party;
- Using the credentials, it will be possible to create an access token.
- The technical contact information is no longer used for sending keys due to security reasons;
- For some Link de pagamentos registrations, the use of the Link via API will not be allowed for business rule reasons. In these cases, the Gerar credenciais de acessos ás APIs button will not be available on the Cielo website. If you have questions about how to proceed, please contact Cielo support;
- If you have previously used a credential, it will stop functioning as soon as you click to generate new credentials.