Inicialização da biblioteca

Operação responsável pela inicialização da biblioteca Client Conecta.

Essa operação realiza o carregamento e a atualização dos parâmetros de funcionamento da biblioteca, além de habilitar as funcionalidades configuradas e permitidas para o estabelecimento.

Após a desinstalação de um terminal, parâmetros de configuração opcionais como TerminalId e Environment devem ser informados novamente. Em inicializações subsequentes de um terminal já configurado, esses parâmetros são desconsiderados ou apenas validados pela biblioteca.

Durante o processo de inicialização, a biblioteca realiza a validação do campo Cnpj do estabelecimento. São aceitos tanto CNPJs compostos exclusivamente por números quanto CNPJs em formato alfanumérico, desde que estejam em um formato válido e consistente.

Caso o CNPJ informado não atenda ao formato esperado por conter caracteres inválidos, estrutura incorreta ou tamanho inadequado, a operação de inicialização não é concluída, impedindo a continuidade da aplicação até que o dado seja corrigido.

A execução bem sucedida desta operação é obrigatória no início da aplicação da Automação Comercial, sendo pré-requisito para a utilização das demais funcionalidades da biblioteca.

Parâmetros de entrada

CampoTipoFormatoPresençaDescrição
OperstringN..3MCódigo da operação: fixo “1” (CFL_OPER_INITIALIZE)
CnpjstringA14MCNPJ do estabelecimento cadastrado na Cielo.
ClientIdstringA36MClient ID associado ao estabelecimento cadastrado no Cielo Conecta.
ClientSecretstringA44MClient Secret associado ao estabelecimento cadastrado no Cielo Conecta.
TerminalIdstringA8OCódigo de terminal utilizado pelo estabelecimento para identificação.
Este campo é mandatório quando a operação de Inicialização é realizada:
  • Pela primeira vez pela aplicação da Automação Comercial.;
  • Após a aplicação da Automação Comercial ter realizado a operação Desassociação do terminal.
Nas demais situações, este campo é apenas validado.
ConfirmationStatusSetupstringN1O

Configuração da confirmação de transação:

“0” = confirmação de transação não é automática. A confirmação de uma transação deve ser realizada pela Automação Comercial através da operação de confirmação definida Gestão de transação pendente
;

“1” = confirmação de transação é automática. A confirmação de uma transação é realizada pela biblioteca Client Conecta (default), não sendo necessária nenhuma ação da Automação Comercial.

PortPinpadstringN..2O

Identificador da porta de comunicação em que o Pin Pad está conectado, de “0” à “99”:

“0” = utiliza a primeira porta disponível, onde é identificada a presença de um Pin Pad;

“NN” = utiliza o Pin Pad conectado na porta NN.

EnvironmentstringN1O

Identificador do ambiente Cielo Conecta para a realização das transações.

Parâmetro opcional por padrão, quando não informado, configura sempre “produção”.

“0” = “Produção”;

“1” = “Homologação”.

Este campo somente tem efeito e é utilizado quando a operação de Inicialização é realizada:
  • Pela primeira vez pela aplicação da Automação Comercial.;
  • Após a aplicação da Automação Comercial ter realizado a operação Desassociação do terminal.
TableParamsUpdatestringN1OForça nova atualização de parâmetros.

Mensagem de notificação recebida na callback da operação

Não há.

Dados de resposta recebido na callback da operação

Não há.

Retornos

CódigoDescrição
CFL_OKInicialização da biblioteca realizada com sucesso
CFL_ERROR_INVOPEROperação inválida ou não reconhecida
CFL_ERROR_MANDATParâmetro mandatório não enviado
CFL_ERROR_TRMID_NOTCONFIGTerminalId não configurado
CFL_ERROR_CNPJCNPJ informado inválido
CFL_ERROR_CLIENTIDClientId informado inválido
CFL_ERROR_CLIENTSECRETClientSecret informado inválido
CFL_ERROR_HASH_CLIENTClientId e ou ClientSecret não conferem com o cadastrado
CFL_ERROR_DATABASEErro no acesso ao banco de dados
CFL_ERROR_TOKENErro na geração do token
CFL_ERROR_MCH_NFOUNDEstabelecimento não cadastrado
CFL_ERROR_TRMIDErro no cadastro do TerminalId
CFL_ERROR_NETWORKErro na comunicação com Cielo Conecta
CFL_ERROR_TABLEPARAMETERSErro na atualização dos parâmetros
CFL_ERROR_PINPADErro no acesso ao Pin Pad

Exemplo

// JSON da operação de inicialização da biblioteca
{
       "Oper":"1",
       "Cnpj":"12343543000199",
       "ClientId":"12dskfjhdskjfds8ew84ieie",
       "ClientSecret":"=dskjfhdskfjhifew0ldsofof9rerf",
       "TerminalId":"PDV00001"
}

Did this page help you?