Consultar cliente

Neste item da integração podemos consultar os dados de um determinado cliente.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeExemplo de valor retornado
ID_CONTRACTRetorna o identificador do contrato.
Ex: 1234

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então a variável ID_CONTRACT ja será preenchida automaticamente.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar contrato

Neste item pode-se consultar contrato(s) do cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
TYPESIMAção a que se destina o contrato.
Ex: desbloqueio_confianca; envio_historico

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeExemplo de valor retornado
ID_CONTRACTRetorna o identificador do contrato.
Ex: 1234
CONTRACTSRetorna o identificador do contrato.
Ex:
Endereço: endereço do cliente
Situação: sitação do cliente
Contrato nº: 1234

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então a variável ID_CONTRACT ja será preenchida automaticamente pelo fluxo.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, deve-se utilizar a variável CONTRACTS para definir a variável ID_CONTRACT e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos (link)

Este item envia boleto (s) em PDF para o cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o(s) link(s) refeente(s) ao(s) for(em) enviado(s) com sucesso

Não encontrado

Quando nenhum link for encontrado

Enviar boletos (e-mail)

Este item envia boletos do cliente por e-mail

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
EMAILSIMConta de e-mail que receberá boleto.
Ex: cliente@email.com

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Enviado

Quando o(s) boleto(s) for(em) enviado(s) com sucesso

Não encontrado

Quando não for enviado nenhum boleto

Desbloqueio por confiança

Neste item é possível realizar o desbloqueio de um contrato

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
ID_CONTRACTSIMNúmero do contrato a ser desbloqueado.
Ex: 1234

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o desbloqueio for realizado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio

Enviar histórico

Neste item é possível enviar o histórico da conversa ao cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
ID_CONTRACTSIMNúmero do contrato a ser desbloqueado.
Ex: 1234
HISTORICSIMHistórico da conversa.
Ex: Conversa registrada que será enviada

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o desbloqueio for realizado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio