Gerenciador de Webservice 

ACESSO: Módulo Integradores → Menu Gerenciador de Webservices   

No Gerenciador de webservice teremos três painéis 

• Configuração de perfis de webservices
• Atividades de webservice dos últimos 90 dias
  
• Atividades de webservice com erro dos últimos 90 dias
  
• Operadores com autorização específica dos serviços de autenticação de usuários.
  
• Atividade de validações de usuários. (90 dias)
  

Configuração de perfis de webservices

Estes perfis irão compor regras para a utilização dos webservices do Sistema MK

No painel de configurações haverão ferramentas para o cadastro e edição de perfis de webservice. 

Para criar um novo perfil clique no botão 'Inserir Novo Perfil'

No primeiro passo do assistente temos os seguintes dados:

• Código - Código auto numerável atribuído pelo banco de dados (bloqueado para edição)
• Ativo(SIM/NÃO) - Define se a regra está ativa
• Data/Hora - Data e hora da criação do perfil (bloqueado para edição)
• Operador - Operador que criou o perfil (bloqueado para edição)
• Tempo de Expiração - Tempo em minutos de expiração do token de autenticação.
• Invalidar(SIM/NÃO) - 
  • Marcando Sim neste campo, o token será invalidado a partir da sua utilização ou 
  • Caso contrário vai respeitar o tempo em minutos informado para ser considerado inválido.
• Contra-senha - 
  • Contra-senha requisitada para a autenticação gerar o token de callback. 
  • O sistema irá sugerir uma contra-senha
  • A contra senha deve ter no mínimo 8 dígitos entre números e caracteres.
• Descrição identificativa do perfil - Informe a descrição que irá identificar o perfil cadastrado em seu sistema.
  
  

Clique no botão 'Próximo' para seguir para o passo seguinte

Neste segundo passo, o operador poderá restringir a utilização dos webservices para determinados endereços de IPs.  

Clique no botão 'Adicionar IP à relação'

Para cada IP Address o operador deverá informar: 

• IP Address - Número de IP autorizado.
• Descrição/Observação - Descrições e observações identificativas que autorizaram este IP

Marque a opção "Tem certeza que deseja gravar este registro?" para confirmar e em seguida clique no botão 'Finalizar' para efetivar o cadastro do IP ao perfil.

Marque a opção 'Limitar consumo de serviços a lista de IPs' para obrigar a inserção de IPs ao perfil e para seja feita a restrição de acesso ao webservices. 

Clique no botão 'Próximo' para seguir para o passo seguinte

Nesse terceiro passo o operador poderá restringir a utilização dos Webservices por usuário do sistema.

Passe para o quadro direito os usuário que terão permissão. 

Clique no botão 'Próximo' para seguir para passo seguinte

Por fim, no último passo serão definidos os webservices autorizados para o perfil. 

Passe para o quadro direito os webservices que farão parte do perfil; 

Marque a opção "Tem certeza que deseja gravar este registro?" para confirmar a operação e clique no botão 'Finalizar' para efetivar o cadastro do perfil. 

Pronto! O perfil de Webservice foi cadastro. 

Atividades de webservice dos últimos 90 dias

Neste painel serão listadas as consultas de webservices realizadas com sucesso 

Selecione o Consumo do Webservice no painel e clique no botão 'Detalhes da atividade' para obter maiores informações 

Observe que no painel há outras opções de visualização de colunas. Veja na imagem abaixo

Atividades de webservice com erro dos últimos 90 dias

Neste painel serão listadas as consultas de webservices realizadas e que ocorreram erro

Selecione o Consumo do Webservice no painel e clique no botão 'Detalhes da atividade' para obter maiores informações 

Observe que no painel há outras opções de visualização de colunas. Veja na imagem abaixo

Operadores com autorização específica dos serviços de autenticação de usuários.

Neste painel teremos uma nova opção de cadastro. O cadastro irá funcionar de forma semelhante ao cadastro do perfil descrito anteriormente

No entanto, na primeira etapa do cadastro, será necessário informar apenas 

• Data Inicial - Data inicial da validade da regra
• Data Final- Data final da validade da regra
• Descrição identificativa do perfil - Informe a descrição que irá identificar o perfil cadastrado em seu sistema

Os próximos passos são iguais ao cadastro de perfil dos serviços gerais 

Atividade de validações de usuários. (90 dias)

Neste painel teremos a listagem de todas as autentificações feitas pela URL WSAutenticacaoOperador (que utiliza o perfil de serviços especifico)

AUTENTICAÇÃO

Para autorizações especificas 

Este é o autenticador para serviços específicos dos webservices abertos do MK

Parâmetros:

• username - usuário de login do sistema (obrigatório)
• password - senha do login do sistema (obrigatório)

Saída

Para autorizações em geral 

Este é o autenticador para serviços gerais dos webservices abertos do MK

Parâmetros:

• token - token do cadastro de usuário 
  
• password - senha do perfil do Webservice 
  
• cd_servico - Código do Serviço de acordo com a tabela abaixo

Exemplo: 

http://IP:PORTA/mk/WSAutenticacao.rule?sys=MK0&token=tokenDoUsuário&password=senhaPerfil&cd_servico=1 

http://IP:PORTA/mk/WSAutenticacao.rule?sys=MK0&token=tokenDoUsuário&password=senhaPerfil&cd_servico=9999

Acima são dois exemplos, onde o cd_servico = 1 quer dizer que somente está pedindo autorização para o serviço 1 (Segunda via de boleto)

Já o serviço com cd_servico =  9999 quer dizer que há autorização para todos os serviços do perfil de autenticação

Saída

Exemplo de uma saída ao chamar o Webservice WSAutenticacao

OBTER INFO DO CLIENTE A PARTIR DO DOCUMENTO (CPF/CNPJ) 

Serviço: Consulta documento

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório) 
  • doc - CPF ou CNPJ do cliente 

Saída

Exemplo de uma saída ao chamar o Webservice WSMKConsultaDoc

OBTER FATURAS PENDENTES DO CLIENTE

Serviço: Consulta de faturas pendentes

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)
  • cd_cliente - Código do Cliente (Obtido por WSMKConsultaDoc ou WSMKUserSenhaSAC)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKFaturasPendentes

VALIDAR ACESSO SAC

Serviço: Validar user/senha SAC

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)
  • user_sac - Usuário do SAC
  • pass_sac - Senha do SAC
    

Saída

Exemplo de uma saída ao chamar o Webservice WSMKUserSenhaSAC

SEGUNDA VIA DE COBRANÇA

Serviço: Segunda via de boleto

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)
  • cd_fatura - Código da fatura (Obtido por WSMKFaturasPendentes)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKSegundaViaCobranca

OBTER CONEXOES DO CLIENTE

Serviço: Conexões por cliente

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)
  • cd_cliente - Código do Cliente (Obtido por WSMKConsultaDoc ou WSMKUserSenhaSAC)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKConexoesPorCliente

OBTER CONTRATOS DO CLIENTE

Serviço: Contratos por cliente

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)
  • cd_cliente - Código do Cliente (Obtido por WSMKConsultaDoc ou WSMKUserSenhaSAC)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKContratosPorCliente

OBTER CLASSIFICACOES DE ATENDIMENTOS

Serviço: Classificações de atendimentos

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKListaClassificacoesAte

OBTER LISTA DE PROCESSOS

Serviço: Processos de atendimentos

Parâmetros:

• • token - token de retorno da autenticação (Obrigatório)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKListaProcessos

ESTRUTURA DE ENDERECOS

Serviço: Estrutura de endereços

Parâmetros: 

• token= token de retorno da autenticação (Obrigatório)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKListaEstruturaEnderecos

CONSULTAR PESSOA PELO NOME 

Serviço: Consulta pessoa pelo nome

Parâmetros: 

• token -  token de retorno da autenticação (Obrigatório)
• nome - Nome do cliente (Obrigatório)

Saída

CONSULTAR DE FATURA POR CÓDIGO DE BARRA

Serviço: Consulta de fatura por código de barras

Parâmetros: 

• token -  token de retorno da autenticação (Obrigatório)
• codigoBarra - Código de barras da fatura (Obrigatório) 

Saída

LINHA DIGITÁVEL POR FATURA VIA SMS

Serviço: Linha digitável por fatura via SMS

Parâmetros: 

• token -  token de retorno da autenticação (Obrigatório)
• codigoDaFatura - Código da fatura (Obrigatório) 

Saída

LISTAR CLIENTES

Serviço: Consultar Cliente

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• doc - documento do cliente (Opcional)

• codigo_bairro - código do bairro do cliente (Opcional)

• nome_cliente - nome do cliente (Opcional)

• data_alteracao_inicio - data inicial de cadastro do(s) cliente(s) (Opcional)

• cd_cliente_inicio - código inicial do(s) cadastro(s) do(s) cliente(s) (Opcional)

• cd_cliente - código do cliente (Opcional)

• data_alteracao_fim - data final de cadastro do(s) cliente(s) (Opcional)

Pelo menos um dos parâmetros opcionais deve ser informado.

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKConsultaClientes:

LISTAR CLIENTES POR CÓDIGO

Serviço: Pessoas - buscar por id

Parâmetros:

• token - token de retorno da autenticação (Obrigatório) 

• cod - código do cadastro do cliente (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

LISTAR PLANOS DE ACESSO POR TIPO DE PLANO

Também é possível utilizar a consulta com o padrão Node:

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• TipoPlano - informar o código conforme tabela:

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaPlanoAcesso:

LISTAR PLANOS DE ACESSO POR DESCRIÇÃO

Serviço: Planos acesso - buscar por descricao

Parâmetros:

• token - token de retorno da autenticação (Obrigatório) 
• nomedoplano - descrição do nome do plano de acesso

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

LISTAR PLANOS DE ACESSO POR EMPRESA

Serviço: Planos acesso - listar por empresa

Parâmetros:

• token - token de retorno da autenticação (Obrigatório) 
• empresa - código da multiempresa

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

LISTAR PLANOS DE ACESSO

Serviço: Listar Planos de Acesso

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• data_alteracao - data de criação do plano (Obrigatório)
• codigo_plano - código do plano (Opcional)
• codigo_plano_inicio - código inicial do plano (Opcional)
• codigo_plano_fim - código final do plano (Opcional)
• ativo - buscar somente planos ativos True/False (Opcional)
• nome_plano - descrição do nome do plano (Opcional)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKConsultaPlanos:

LISTAR PLANOS DE ACESSO POR PRODUTO DO CRM

Serviço: Listar Planos de Acesso

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• data_alteracao - data de criação do produto (Opcional)
• codigo_produto - código do produto (Opcional)
• codigo_produto_inicio - código inicial do produto (Opcional)
• codigo_produto_fim - código final do produto (Opcional)
• ativo - buscar somente produtos ativos S/N (Opcional)
• nome_produto - descrição do nome do produto (Opcional)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKConsultaPlanos:

LISTAR REGRAS DE VENCIMENTO

Serviço: Listar Regras de Vencimento

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
  

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaRegraVencimento:

LISTAR TABELAS DE SLA

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaTabelaSLA:

LISTAR REGRAS DE BLOQUEIO

Serviço: Listar Regras de Bloqueio

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaRegraBloqueio:

LISTAR PROFILES DE PAGAMENTO

Serviço: Listar Profiles de Pagamento

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaProfilePagamento:

LISTAR DESCONTOS

Serviço: Listar Descontos

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKListaDesconto:

LISTAR PLANO DE CONTAS

Serviço: Listar Planos de Contas

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKPlanoContas:

LISTAR EQUIPES DE OS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

LISTAR TÉCNICOS RESPONSÁVEIS PARA AS OS

Serviço: OS - Listar Técnico Responsável

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

LISTAR TIPOS DE OS

Serviço: OS - listar por tipo Os

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

LISTAR OS POR CÓDIGO

Serviço: OS - buscar por id

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• id - código da OS (Obrigatório)

Exemplo de saída:

LISTAR OS POR CLIENTE

Serviço: OS - listar por cliente

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• pessoa - código do cliente (Obrigatório)

Exemplo de saída:

LISTAR CONTRATOS POR STATUS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• cd_cliente - código do cadastro do cliente (Obrigatório)

Exemplo de saída:

LISTAR CONEXÕES POR MOTIVO DE BLOQUEIO

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• cd_cliente - código do cliente (Obrigatório)
• bloqueada - S/N (Opcional)
• motivo_bloqueio - código do motivo de bloqueio  (Opcional)

Exemplo de saída:

CONSULTAR CLIENTES POR CÓDIGO

Serviço: Pessoas - buscar por id

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• id - código do cadastro do cliente

Exemplo de saída:

CONSULTAR CLIENTES POR NOME

Serviço: Pessoas - listar por nome

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• nome - nome do cliente (Obrigatório)

Exemplo de saída:

CONSULTAR CLIENTES POR EMPRESA

Serviço: Pessoas - listar por empresa

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• empresa - código da multiempresa (Obrigatório)

Exemplo de saída:

CONSULTAR CLIENTES POR TELEFONE

Serviço: Pessoas - listar por telefone

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• ddd - DDD do número do cliente (Obrigatório)
• fone - número do celular (Obrigatório)

Exemplo de saída:

Exemplo de saída:

LISTAR SERVIDORES

Serviço: Conexão - Listar Concentrador

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• dataConnection - nome da multiempresa (Opcional)

Exemplo de saída:

LISTAR PLANOS DE ACESSO POR SERVIDOR

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• CodigoServidor - código do servidor (Obrigatório)

Exemplo de saída:

LISTAR PONTOS DE ACESSO

Serviço: Conexão - Pontos de Acesso

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• dataConnection - nome da multiempresa (Opcional)

Exemplo de saída:

LISTAR IPS DISPONÍVEIS

Serviço: Conexão - Listar IPs

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• CodigoPontoAcesso - código do ponto de acesso (Obrigatório)
• CodigoServidor - código do servidor (Obrigatório)

Exemplo de saída:

CRIAR LOGRADOURO

Serviço: Logradouros - incluir

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• nome - nome do logradouro (Obrigatório)
• cep - CEP (Obrigatório)
• bairroId - código do bairro (Obrigatório)
• cidadeId - código da cidade (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

ALTERAR LOGRADOURO

Serviço: Logradouros - editar

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• nome - novo nome para o logradouro (Opcional)
• cep - novo CEP para o logradouro (Opcional)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

CRIAR BAIRRO

Serviço: Bairros - incluir

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

• nome - nome do novo bairro (Obrigatório)
• cidadeId - código da cidade (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

ALTERAR BAIRRO

Serviço: Bairros - editar

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• id - código do bairro (Obrigatório)
• nome - novo nome do bairro (Obrigatório)

CRIAR CIDADE

Serviço: Cidades - incluir

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• nome - nome da cidade (Obrigatório)
• IBGE - código do IBGE da cidade (Obrigatório)
• estado - código do estado (Obrigatório)

Exemplo de saída:

ALTERAR CIDADE

Serviço: Cidades - editar

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• id - código da cidade (Obrigatório)
• nome - nome da cidade (Opcional)
• IBGE - código do IBGE da cidade (Opcional)

LISTAR CIDADE POR UF

Serviço: Cidades - buscar por uf

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• uf - sigla do estado (Obrigatório)

LISTAR ATENDIMENTOS POR PERÍODO (COM RETORNO INFORMANDO O CÓDIGO DO ATENDENTE)

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• data_inicio= período do atendimento no formato ano/mês/dia (Obrigatório)

LISTAR ATENDENTES

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• codigo_atendente - obtido em WSMKAtendimentos (Obrigatório)

LISTAR ATENDIMENTOS POR STATUS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

LISTAR CLIENTES POR CÓDIGO

Parâmetros:

• token - token de retorno da autenticação (Obrigatório) 

• cod - código do cadastro do cliente (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice:

LISTAR CONTRATOS POR PLANO DE ACESSO OU PRODUTO DO CRM

Parâmetros:

• token - token de retorno da autenticação (Obrigatório) 
• codigo_plano - código do plano de acesso ou produto do CRM (Obrigatório) 
• cancelado - se informado N considerar somente os contratos ativos, se S todos os contratos com o plano de acesso (Obrigatório)
• suspenso - se informado N considerar somente os contratos ativos, se S todos os contratos com o plano de acesso (Obrigatório)
• data_adesao_inicial - data inicial para filtrar somente contratos criados após o período (Opcional)
• data_adesao_final - data final para filtrar somente contratos criados antes do período (Opcional)
• aguarda_ativacao - se informado N considerar somente os contratos ativos, se S todos os contratos incluindo os que aguardam a ativação com o plano de acesso (Obrigatório)

Paramêtros adicionados na release nº 57:

• data_cancelamento_inicial  - data inicial para filtrar somente contratos cancelados no período (Opcional)
• data_cancelamento_final data final para filtrar somente contratos cancelados no período (Opcional)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice caso nenhum contrato for localizado de acordo com os parâmetros preenchidos será retornado somente informações sobre o plano de acesso:

Exemplo de uma saída ao chamar o Webservice quando forem localizados contratos:

ALTERAR SENHA DE ACESSO AO SAC EM MASSA E ENVIAR NOVA SENHA POR SMS AOS CLIENTES

Onde:

• token - token de retorno da autenticação (Obrigatório)
• tag - TAG informada no cadastro do cliente (Opcional)
• cd_clientes - código do(s) cliente(s) separados por pipes - barras verticais | - (Opcional)
• conexao_ativa - S para alterar e enviar a nova senha somente para clientes com conexão desbloqueada, N para enviar para todos os clientes independente do status da conexão (Opcional)
• contrato_ativos - S para alterar e enviar a nova senha somente para clientes com contrato ativo, N para enviar para todos os clientes independente do status do contrato (Obrigatório)

A nova senha gerada leva em conta os requisitos de segurança, com 8 caracteres no mínimo e com letras e números e letras maiúsculas e minúsculas. O envio do SMS será feito pela operadora de SMS que deve estar cadastrada na configuração do mk erp.

Exemplo de saída:

LISTAR CONDOMÍNIOS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice: