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
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
CLIENT_IDSIMID único de acesso a API.
Ex: 12345
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
CPF_CNPJSIMDocumento do cliente.
Ex: 000.000.000-00

Variáveis criadas

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

Retornos

Encontrado

Quando for encontrado resultado para esta consulta.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar serviços

Neste item pode-se consultar o(os) serviços(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
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
CLIENT_IDSIMID único de acesso a API.
Ex: 12345
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
CPF_CNPJSIMDocumento do cliente.
Ex: 000.000.000-00

Variáveis criadas

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

NomeExemplo de valor retornado
SERVICE_IDretorna o identificador unico do cliente.
Ex: 12345
SERVICESLista dos serviços encontrados.
Ex:
['1':'1','2':'2']
MSG_SERVICESLista dos serviços encontrados.
Ex:
1 - serviço 01
2 - serviç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 SERVICE_ID 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 MSG_SERVICES para definir a variavel SERVICE_ID 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

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
CLIENT_IDSIMID único de acesso a API.
Ex: 12345
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
CPF_CNPJSIMDocumento 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 boleto for encontrado e enviado com sucesso

Não encontrado

Quando o boleto não for encontrado

Enviar boletos (e-mail)

Este item envia boleto por e-mail para o cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
CPF_CNPJSIMDocumento do cliente.
Ex: 000.000.000-00
ID_CLIENTSIMID único de identificação do usuário.
Ex: 12345
TYPE_ACTIONSIMRaio de alcance da busca.
Ex: email | sms

Variáveis criadas

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

Retornos

Encontrado

Quando o boleto for encontrado e enviado com sucesso

Não encontrado

Quando o boleto não for encontrado

Linha digitável

Este item retorna a linha digitável dos boleos em aberto 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
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
CPF_CNPJSIMDocumento do cliente.
Ex: 000.000.000-00

Variáveis criadas

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

Retornos

Encontrado

Quando a liha digitável for encontrada e enviada com sucesso

Não encontrado

Quando a linha digitável não for encontrada

Desbloqueio por confiança

Neste item é possível realizar o desbloqueio de um serviço

Itens dependentes

Nome
Consultar serviços

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
SERVICE_IDSIMID único do serviço.
Ex: 1234
DAYS_UNLOCKNÃOQuantidade de dias que ficará desbloqueado.
Ex: 0 | 1 | 10 | etc...

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 ou o contrato não foi localizado

Abrir atendimento

Neste item é possível realizar a abertura de um atendimento

Itens dependentes

Nome
Consultar serviços

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
GRANT_TYPESIMTIpo de validação.
Ex: password
CLIENT_SECRETSIMValor do client_secret.
Ex: mI00ib4pQrp261feeefdfdf
CLIENT_IDSIMID único de acesso a API.
Ex: 12345
LOGINSIMLogin de acesso a API.
Ex: usuario123
PASSWORDSIMSenha de acessoa API.
Ex: 121d3d34f34
SERVICE_IDSIMID único do serviço.
Ex: 1234
OPEN_OSSIMID único do serviço.
Ex: 1234
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...
USER_NAMESIMNome do solicitante.
Ex: José Joaquim Maria
PHONESIMTelefone do solicitante.
Ex: (99) 9 9999-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
PROTOCOLNúmero do protocolo do atendimento.
Ex: 2004201120569

Retornos

Encontrado

Quando abertura de atendimento for realizada com sucesso

Não encontrado

Quando não for possível abrir atendimento