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
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
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
CLIENT_IDretorna o identificador unico do cliente.
Ex: 158
TYPETipo de cliente.
Ex: Pré-venda | Assinante
CODE_TYPECódigo do tipo de cliente.
Ex: 321

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então a variável CLIENT_ID ja será preenchida automaticamente. Também serão preenchidas automaticamente as variáveis TYPECODE_TYPE. pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar e-mails

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

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_IDSIMIdentificador único do 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
EMAILE-mail do usuário.
Ex: exemplo@email.com
LIST_EMAILSLista de e-mails do usuário.
Ex:
exemplo01@email.com
exemplo02@email.com

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 email encontrado, então a variável EMAIL já 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 LIST_EMAILS para definir a variável EMAIL e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos (PDF)

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
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
STATUS_TITLESIMDetermina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual

Variáveis criadas

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

Retornos

Encontrado

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

Não encontrado

Quando o boleto não for encontrado

Enviar boletos (e-mail)

Este item envia boletos do cliente por e-mail

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
EMAILSIME-mail que receberá boleto.
Ex: exemplo01@email.com
EMAIL_MESSAGESIMMensagem do e-mail.
Ex: Aqui vai a mensagem...
STATUS_TITLESIMDetermina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual

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

Enviar boletos (link)

Este item retorna link (s) para download do (s) boleto (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
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
STATUS_TITLESIMDetermina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual

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

Enviar linha digitável

Este item envia linha digitável do (s) boleto (s) 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
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
STATUS_TITLESIMDetermina quais boletos serão retornados.
Ex:
0 = todos | 1 = atrasados | 2 = mês atual

Variáveis criadas

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

Retornos

Encontrado

Quando a (s) linha (s) digitável (is) for (em) enviada (s) com sucesso

Não encontrado

Quando nenhuma linha digitável for encontrado

Desbloqueio por confiança

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

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CLIENT_IDSIMIdentificador único do cliente.
Ex: 000.000.000-00

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

Abertura de chamado

Neste item é possível realizar abertura de chamado

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
REQUESTERSIMCódigo do solicitante.
Ex: 2
ORIGIN_CODESIMCódigo de origem de atendimento.
Ex: 5
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...
TYPE_TICKET_CODSIMCódigo do tipo de atendimento.
Ex: 40001
REQUESTER_NAMESIMNome do solicitante.
Ex: José Maria
REQUESTER_DEGREESIMGrau do solicitante.
Ex: 1

Variáveis criadas

NomeExemplo de valor retornado
PROTOCOLNúmero do protocolo do atendimento.
Ex: 2004201120569

Retornos

Encontrado

Quando o chamado for aberto com sucesso, então a variável PROTOCOL ja será preenchida automaticamente pelo fluxo.

Não encontrado

Quando não for possível abrir chamado