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
| Campo | Tipo | Formato | Presença | Descrição |
|---|---|---|---|---|
Oper | string | N..3 | M | Código da operação: fixo “1” (CFL_OPER_INITIALIZE) |
Cnpj | string | A14 | M | CNPJ do estabelecimento cadastrado na Cielo. |
ClientId | string | A36 | M | Client ID associado ao estabelecimento cadastrado no Cielo Conecta. |
ClientSecret | string | A44 | M | Client Secret associado ao estabelecimento cadastrado no Cielo Conecta. |
TerminalId | string | A8 | O | Código de terminal utilizado pelo estabelecimento para identificação. Este campo é mandatório quando a operação de Inicialização é realizada:
|
ConfirmationStatusSetup | string | N1 | O | 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. |
PortPinpad | string | N..2 | O | 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. |
Environment | string | N1 | O | 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:
|
TableParamsUpdate | string | N1 | O | Forç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ódigo | Descrição |
|---|---|
CFL_OK | Inicialização da biblioteca realizada com sucesso |
CFL_ERROR_INVOPER | Operação inválida ou não reconhecida |
CFL_ERROR_MANDAT | Parâmetro mandatório não enviado |
CFL_ERROR_TRMID_NOTCONFIG | TerminalId não configurado |
CFL_ERROR_CNPJ | CNPJ informado inválido |
CFL_ERROR_CLIENTID | ClientId informado inválido |
CFL_ERROR_CLIENTSECRET | ClientSecret informado inválido |
CFL_ERROR_HASH_CLIENT | ClientId e ou ClientSecret não conferem com o cadastrado |
CFL_ERROR_DATABASE | Erro no acesso ao banco de dados |
CFL_ERROR_TOKEN | Erro na geração do token |
CFL_ERROR_MCH_NFOUND | Estabelecimento não cadastrado |
CFL_ERROR_TRMID | Erro no cadastro do TerminalId |
CFL_ERROR_NETWORK | Erro na comunicação com Cielo Conecta |
CFL_ERROR_TABLEPARAMETERS | Erro na atualização dos parâmetros |
CFL_ERROR_PINPAD | Erro 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"
}Updated 16 days ago