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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
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
PERSON_CODEretorna o identificador único do cliente.
Ex: 158
SITUATIONSituação do cliente no CRM.
Ex: Ativo | Inativo
EMAILEndereço de e-mail do cliente.
Ex: exemplo@email.com
ADDRESSEndereço do cliente.
Ex: Rua 01, 123
NAMENome completo do cliente.
Ex: JOSE DA SILVA
PHONE_NUMBERTelefone do cliente.
Ex: (99) 99999-9999

Retornos

Encontrado

Quando for encontrado resultado para esta consulta.

Se o retorno for cliente encontrado, então serão preenchidas as seguintes variáveis: PERSON_CODESITUATIONEMAILADDRESSNAMEPHONE_NUMBER automaticamente pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Listar processos

Neste item pode-se consultar a lista de processos disponíveis que serão utilizados na 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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999

Variáveis criadas

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

NomeExemplo de valor retornado
MSG_PROCESSESretorna lita de processos.
Ex:
1 - processo 01
2 - processo 02

Retornos

Encontrado

Quando for encontrado apenas 1 ou vários resultados para esta consulta.

Caso a consulta retorne resultado (s), então a variável MSG_PROCESSES já será preenchida automaticamente pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Listar classificações

Neste item pode-se consultar a lista de classificações disponíveis que serão utilizadas na 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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999

Variáveis criadas

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

NomeExemplo de valor retornado
MSG_CLASSIFICATIONSretorna lita de classificações.
Ex:
1 - classificação 01
2 - classificação 02

Retornos

Encontrado

Quando for encontrado apenas 1 ou vários resultados para esta consulta.

Caso a consulta retorne resultado (s), então a variável MSG_CLASSIFICATIONS ja será preenchida automaticamente pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar conexão do cliente

Neste item pode-se consultar a (s) conexão (ões) 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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
PERSON_CODESIMCódigo do cliente.
Ex: 123

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_CONCECTIONretorna ID da conexão.
Ex:
321
MSG_CONNECTIONSretorna lita de conexões.
Ex:
1 - conexão 01
2 - conexão 02
CONNECTIONSretorna lita de conexões.
Ex:
[{'1':'conexão 01', '2': 'conexão 02}]

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

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

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar contratos

Neste item pode-se consultar contrato 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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
PERSON_CODESIMCódigo do cliente.
Ex: 123

Variáveis criadas

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

NomeExemplo de valor retornado
ACCESSIONData de adesão.
Ex:
2015-10-06
NAMENome completo do cliente.
Ex: JOSE DA SILVA
STATUSstatus do cliente.
Ex:
OK

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 contrato encontrado, então as variáveis ACCESSIONNAMESTATUS já serão preenchidas automaticamente pelo fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar boletos

Este item retorna uma listagem de boletos 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
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
PERSON_CODESIMCódigo do cliente.
Ex: 123

Variáveis criadas

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

NomeExemplo de valor retornado
INVOICE_CODEretorna ID do boleto.
Ex:
321
MSG_INVOICESretorna mensagem com boletos.
Ex:
1 - boleto 01
2 - boleto 02
INVOICESretorna lista de boletos.
Ex:
[{'id': '1','cod': '2345'}, {'id':'2', 'cod': '2346}]

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 boleto encontrado, então as variáveis INVOICE_CODE 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 MSG_INVOICES para definir a variável INVOICE_CODE 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 em PDF para o cliente

Itens dependentes

Nome
Consultar boletos

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
INVOICE_CODESIMCódigo do boleto.
Ex: 2345
INVOICESSIMlista de boletos.
Ex:
[{'id': '1','cod': '2345'}, {'id':'2', 'cod': '2346}]

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 conexões do cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
ID_CONNECTIONSIMCódigo da conexão.
Ex: 2345
CONNECTIONSSIMlista de conexões.
Ex:
[{'id': '1','cod': '2345'}, {'id':'2', 'cod': '2346}]

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

Nome
Consultar cliente
Listar processos
Listar classificações

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
TOKENSIMToken de autenticação.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
PASSWORDSIMSenha de acesso a API.
Ex: zU7mI00ib4pQrp261feeefdfdfdg
CD_SERVICESIMCódigo dos serviços acessíveis na API.
Ex: 9999
PERSON_CODESIMCódigo do cliente.
Ex: 9999
PROCESS_IDSIMCódigo do processo.
Ex: 123
CLASS_IDSIMCódigo da classificação.
Ex: 123
ORIGIN_CONTACTSIMCódigo origem do contato.
Ex: 1 | 2 | 3
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...

Variáveis criadas

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

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

Retornos

Encontrado

Quando o chamado for aberto com sucesso

Não encontrado

Quando não for possível abrir chamado