Page tree
Skip to end of metadata
Go to start of metadata

Índice

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.

Atenção

(warning) A liberação deste perfil é de sua inteira responsabilidade, assim como o consumo dos serviços a ele atrelados (warning)

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. 

Atenção

A verificação do usuário na autenticação será feita sobre o token do seu cadastro

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 


Atenção

(warning) A liberação deste perfil é de sua inteira responsabilidade, assim como o consumo dos serviços a ele atrelados (warning)

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

Onde:

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

Saída

Observação

Apenas os usuário definidos no perfil de webservices para serviços específicos que vão consegui realizar esta autenticação

Para autorizações em geral 

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


Onde:

  • 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
Código ServiçoServiço
1Segunda via de boleto
2Auto-desbloqueio
3Abertura de atendimento
4Validar user/senha SAC
5Criar nova LEAD
6Consultar documento
7Consulta de faturas pendentes
8Contratos por cliente
9Conexões por cliente
10Classificações de atendimento
11Processos de atendimentos
12Nova pessoa
13Nova cidade
14Novo bairro
15Novo logradouro
16Estrutura de endereços
17Consultar pessoa pelo nome
18Pedido de liquidação de faturas
19Processo de liquidação de faturas
20Consulta de fatura por código de barras
21Linha digitável por fatura via SMS

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

Atenção

Através da Autenticação será retornado o tokenRetornoAutenticacao, será este token que os demais webservices utilizarão como parâmetro de entrada

Exemplo 01:

Observe que é exibido o tempo de expiração do token de autenticação e o limite de uso. No imagem acima informa que não há limite de uso até a data 23/09/219 e hora 18:23:57 e está autorizado apenas para o serviço 1

Exemplo 02:

Observe que é exibido o tempo de expiração do token de autenticação e o limite de uso. No imagem acima informa que não há limite de uso até a data 24/09/219 e hora 20:52:08 e está autorizado para todos os serviços do perfil

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

URL PARA OBTER INFO DO CLIENTE A PARTIR DO DOCUMENTO


IP:PORTA/mk/WSMKConsultaDoc.rule?sys=MK0&token=tokenRetornoAutenticacao&doc=cpf/cnpj

Onde:

    • 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

URL PARA OBTER FATURAS PENDENTES


IP:PORTA/mk/WSMKFaturasPendentes.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_cliente=codigoCliente

Onde:

    • 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

URL PARA VALIDAR ACESSO AO SAC


IP:PORTA/mk/WSMKUserSenhaSAC.rule?sys=MK0&token=tokenRetornoAutenticacao&user_sac=usuarioSAC&pass_sac=senhaSAC

Onde:

    • 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

URL PARA OBTER SEGUNDA VIA DE COBRANÇA


IP:PORTA/mk/WSMKSegundaViaCobranca.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_fatura=codigoFatura

Onde:

    • 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

AUTO-DESBLOQUEIO

URL PARA AUTO-DESBLOQUEIO


IP:PORTA/mk/WSMKAutoDesbloqueio.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_conexao=codigoConexao

Onde:

    • token - token de retorno da autenticação (Obrigatório)
    • cd_conexao - Código da conexão (Obtido por WSMKConexoesPorCliente)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKAutoDesbloqueio

OBTER CONEXOES DO CLIENTE

URL PARA OBTER CONEXÕES PENDENTES


IP:PORTA/mk/WSMKConexoesPorCliente.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_cliente=codigoCliente

Onde:

    • 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

URL PARA OBTER CONTRATOS PENDENTES


IP:PORTA/mk/WSMKContratosPorCliente.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_cliente=codigoCliente

Onde:

    • 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

URL PARA OBTER CLASSIFICAÇÕES DE ATENDIMENTO


IP:PORTA/mk/WSMKListaClassificacoesAte.rule?sys=MK0&token=tokenRetornoAutenticacao

Onde:

    • 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

URL PARA OBTER LISTA DE PROCESSO


IP:PORTA/mk/WSMKListaProcessos.rule?sys=MK0&token=tokenRetornoAutenticacao

Onde:

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

Saída

Exemplo de uma saída ao chamar o Webservice WSMKListaProcessos

ABERTURA DE ATENDIMENTOS

URL PARA ABERTURA DE ATENDIMENTO


IP:PORTA/mk/WSMKNovoAtendimento.rule?sys=MK0&token=tokenRetornoAutenticacao

&cd_contrato=codigoContrato
&cd_cliente=codigoCliente
&cd_processo=codigoProcesso
&cd_classificacao_ate=codigoClassificacaoAtendimento
&origem_contato=codigoOrigemContato
&cd_grupo_visualizadores=codigoGrupoVisualizadoresinfo
&info='informacaoAtendimento'

Onde:

    • token - token de retorno da autenticação (Obrigatório)
    • cd_contrato - Código do contrato (Obtido por WSMKContratosPorCliente)
    • cd_cliente - Código do cliente (Obtido por WSMKConsultaDoc ou WSMKUserSenhaSAC)
    • cd_processo - Código do Processo (Obtido por WSMKListaProcessos)
    • cd_classificacao_ate - Código da classificação de atendimento (Obtido por WSMKListaClassificacoesAte)
    • origem_contato - Código da origem de contrato de acordo com o tabela abaixo

      CódigoDescrição
      1Email
      2Outros
      3Presencial
      4SAC
      5Site
      6Telefônico
      7Através de um técnico
      8CRM
      9Whatsapp
      10Facebook
      11Instagram
      12Messenger
      13MKBot Assistant
      14Monitoramento
    • cd_grupo_visualizadores - Código do grupo de visualizadores de acordo com seus cadastros no sistema 

    • info - Informação sobre o atendimento

Atenção

  • O campo cd_contrato não é obrigatório.
    • Caso não informado, será ignorado. Neste caso, a empresa é obtida do cadastro de pessoas
    • Ao informá-lo, o sistema vai obter dele a Conexão associada e também a Empresa.
  • O campo cd_grupo_visualizadores também é opcional. Caso não informado a visualização fica somente para os participantes do subprocesso do processo informado.
  • O sistema vai validar se o contrato é da pessoa, se o processo existe, se está ativo, e se a classificação existe e não é de encerramento.
  • Clientes inativos também não podem abrir atendimento.

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovoAtendimento

ABERTURA DE LEAD

URL PARA ABERTURA DE LEAD


IP:PORTA/mk/WSMKNovaLead.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_cliente=codigoCliente&info='informacaoAtendimento'

Onde: 

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

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovaLead


NOVA PESSOA

URL PARA CADASTRO DE PESSOAS


IP:PORTA/mk/WSMKNovaPessoa.rule?sys=MK0&token=tokenRetornoAutenticacao
&doc=cpf/cnpj
&nome='nomecliente'
&cep=cepEndereco
&cd_uf=codigoEstado
&cd_cidade=codigoCidade
&cd_bairro=codigoBairro
&cd_logradouro=codigoLogradouro
&numero=numeroEndereco
&complemento='complementoEndereco'
&cd_empresa=codigoEmpresa
&email=enderecoEMAIL
&nascimento=aa/mm/aaaa
&fone=numeroTelefone
&lat=latitude
&lon=longitude

Onde: 

  • token= token de retorno da autenticação (Obrigatório)
  • doc= Documento CPF ou CNPJ (Obrigatório)
  • nome= Nome completo do cliente (Obrigatório)
  • cep= CEP do endereço do cliente (Obrigatório)
  • cd_uf= Código do Estado (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cd_cidade= Código do Cidade (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cd_bairro= Código do Bairro (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cd_logradouro= Código do Logradouro (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • numero= Número do endereço do cliente (Obrigatório)
  • complemento=  Complemento do endereço do cliente
  • cd_empresa= Código da empresa em que o cliente será cadastrado 
  • email= Endereço de e-mail do cliente (Obrigatório)
  • nascimento= Dia, mês e ano do nascimento do cliente
  • fone= Número de telefone (Obrigatório)
  • lat= Latitude do endereço 
  • lon= Longitude do endereço

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovaPessoa

ESTRUTURA DE ENDERECOS

URL OBTER A ESTRUTURA DE ENDEREÇOS


IP:PORTA/mk/WSMKListaEstruturaEnderecos.rule?sys=MK0&token=tokenRetornoAutenticacao

Onde: 

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

Saída

Exemplo de uma saída ao chamar o Webservice WSMKListaEstruturaEnderecos


NOVA CIDADE

URL CADASTRAR NOVA CIDADE


IP:PORTA/mk/WSMKNovaCidade.rule?sys=MK0&token=tokenRetornoAutenticacao
&cidade='nomeCidade'
&cd_uf=codigoEstado
&cd_ibge=codigoIBGE

Onde: 

  • token -  token de retorno da autenticação (Obrigatório)
  • cidade - Nome da Cidade (Obrigatório)
  • cd_uf - Código do Estado (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cd_ibge - Código do IBGE (Obrigatório)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovaCidade


NOVO BAIRRO

URL CADASTRAR NOVO BAIRRO


IP:PORTA/mk/WSMKNovoBairro.rule?sys=MK0&token=tokenRetornoAutenticacao

&bairro='nomeBairro'
&cd_cidade=codigoCidade

Onde: 

  • token -  token de retorno da autenticação (Obrigatório)
  • bairro - Nome do Bairro (Obrigatório)
  • cd_cidade - Código da Cidade (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovoBairro

NOVO LOGRADOURO

URL CADASTRAR NOVO LOGRADOURO


IP:PORTA/mk/WSMKNovoLogradouro.rule?sys=MK0&token=tokenRetornoAutenticacao
&logradouro='nomedoLogradouro'
&cd_cidade=codigoCidade
&cd_bairro=codigoBairro
&cep=cepEndereco

Onde: 

  • token -  token de retorno da autenticação (Obrigatório)
  • logradouro - Nome o logradouro
  • cd_cidade - Código da Cidade (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cd_bairro - Código do Bairro (Obrigatório) (Obtido por WSMKListaEstruturaEnderecos)
  • cep - CEP do endereço (Obrigatório)

Saída

Exemplo de uma saída ao chamar o Webservice WSMKNovoLogradouro


CONSULTAR PESSOA PELO NOME 

CONSULTAR PESSOA PELO NOME


IP:PORTA/mk/WSMKConsultaNome.rule?sys=MK0&token=tokenRetornoAutenticacao&nome=nomeCliente

Onde: 

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

Saída

Atenção

Para campos que terão informações separadas por 'espaço' utilize aspas simples
(warning) É fundamental somente autorizar perfils de webservices em ambiente https por questões de segurança dos seus dados (warning)

PEDIDO DE LIQUIDAÇÃO DE FATURAS 

Esse serviço prepara para um pedido de liquidação.  Está sendo inicialmente usado em nosso APP de pagamentos, mas pode ser utilizado por outro sistemas. 

CONSULTAR PESSOA PELO NOME


IP:PORTA/mk/WSMKPedidoLiquidacao.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_cliente=codigoCliente&faturas=codigoFatura1;codigoFatura2;codigoFatura3;...

Onde: 

  • token -  token de retorno da autenticação (Obrigatório)
  • cd_cliente - Código do cadastro do cliente (Obrigatório)
  • faturas - Código da fatura do cliente informando em cd_cliente(Obrigatório)
    • Aqui poderá ser informado um ou mais códigos de faturas separados por ponto e virgula

Atenção

  • WSMKPedidoLiquidacao:
    • Aceita apenas faturas a receber 
    • Não aceitará faturas excluídas, suspensas e liquidadas 
    • cd_cliente faturas devem ser do mesmo cliente

Saída

Na saída temos 3 blocos de retorno 

  • FaturasDetalhes: Onde serão listadas as faturas informadas na URL
    • O valor a cobrar mostrará o valor final com descontos e acréscimos calculados de acordo com as regras definidas para o cliente no sistema.   
  • FormasPgto: As formas de pagamos serão as condições de pagamento que o valor a ser pago se enquadra. Saiba mais sobre o cadastro destas condições em 
  • No final temos ainda:
    • IDPagamento: Apresenta um token que deverá ser utilizado pelo webservice WSMKLiquidacaoFaturas

    • ValorTotal: Apresenta a soma dos valores a ser cobrado das faturas listadas 

    • ValorTotalAcreApresenta a soma dos valores de acréscimo das faturas listadas 

    • ValorTotalDes: Apresenta a soma dos valores de desconto das faturas listadas 

Observe que no inicio temos uma data/hora de expiração, que determiná o tempo em que o retorno poderá ser utilizado  


PROCESSO DE LIQUIDAÇÃO DE FATURAS 

CONSULTAR PESSOA PELO NOME


IP:PORTA/mk/WSMKLiquidacaoFaturas.rule?sys=MK0&token=tokenRetornoAutenticacao&IDPagamento=IDPagamento&FormaPgto=CondicaoPagamento&conta=contaBanco&NSU=numeroNSU&ARP=numeroARP

Onde: 

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

  • IDPagamento - IDPagamento retornado pelo webservice WSMKPedidoLiquidacao (Obrigatório)

  • FormaPgto - Condição de pagamento escolhido para a liquidação  (Obrigatório)


  • conta - Código da conta Banco que o valor liquidado deverá entrar (Obrigatório) .

  • NSU - numero de NSU
  • ARP - número ARP

Saída

CONSULTAR DE FATURA POR CÓDIGO DE BARRA


CONSULTAR PESSOA PELO NOME

IP:PORTA/mk/WSMKConsultaBarras.rule?sys=MK0&token=tokenRetornoAutenticacao&barras=codigoBarra

Onde: 

  • 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


CONSULTAR PESSOA PELO NOME

IP:PORTA/mk/WSMKLDViaSMS.rule?sys=MK0&token=tokenRetornoAutenticacao&cd_fatura=codigoDaFatura

Onde: 

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

Saída

  • No labels