Interfocus


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

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00

Variaveis criadas

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

Nome Exemplo de valor retornado
ID_CONTRACT Retorna o identificador do contrato.
Ex: 1234

Retornos

{success.fa-check} 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.

{danger.fa-close} 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

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00
TYPE SIM Ação a que se destina o contrato.
Ex: desbloqueio_confianca; envio_historico

Variaveis criadas

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

Nome Exemplo de valor retornado
ID_CONTRACT Retorna o identificador do contrato.
Ex: 1234
CONTRACTS Retorna o identificador do contrato.
Ex:
Endereço: endereço do cliente
Situação: sitação do cliente
Contrato nº: 1234

{success.fa-check} 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.

{warning.fa-exclamation} 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 variavel ID_CONTRACT e então prosseguir com a integração.

{danger.fa-close} 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.

{info.fa-arrow-right}Serão retornados todos os boletos em aberto até o mês atual.
Ex.: Se o cliente tem os boletos de maio/2020 e junho/2020 em aberto, e realiza a consulta no mês de julho/2020, serão retornados os boletos de maio/2020, junho/2020 e julho/2020.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00

Variaveis criadas

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

Retornos

{success.fa-check} Encontrado

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

{danger.fa-close} Não encontrado

Quando nenhum link for encontrado

Enviar boletos (e-mail)

Este item envia boletos do cliente por e-mail.

{info.fa-arrow-right}Serão enviados por e-mail todos os boletos em aberto.
Ex.: Se o cliente tem os boletos de maio/2020 e junho/2020 em aberto, e realiza a consulta no mês de julho/2020, serão enviados por e-mail os boletos de maio/2020, junho/2020 e julho/2020.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00
EMAIL SIM Conta de e-mail que receberá boleto.
Ex: cliente@email.com

Variaveis criadas

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

Retornos

{success.fa-check} Enviado

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

{danger.fa-close} 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

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
ID_CONTRACT SIM Número do contrato a ser desbloqueado.
Ex: 1234

Variaveis criadas

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

Retornos

{success.fa-check} Encontrado

Quando o desbloqueio for realizado com sucesso

{danger.fa-close} 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

Nome Obrigatório Exemplo
HOST SIM Host da API do integrador.
Ex: http://exemplo.com
LOGIN SIM Login de acesso a API.
Ex: integracao@exemplo.com
PASSWORD SIM Senha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJ SIM Documento para consulta de cliente.
Ex: 000.000.000-00
ID_CONTRACT SIM Número do contrato a ser desbloqueado.
Ex: 1234
HISTORIC SIM Histórico da conversa.
Ex: Conversa registrada que será enviada

Variaveis criadas

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

Retornos

{success.fa-check} Encontrado

Quando o desbloqueio for realizado com sucesso

{danger.fa-close} Não encontrado

Quando não for possível realizar o desbloqueio