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)

Atenção

Para campos que terão informações separadas por 'espaço' utilize aspas simples
(warning) É fundamental somente autorizar perfis de webservices em ambiente https por questões de segurança dos seus dados (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

Parâmetros:

  • 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


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
Código ServiçoServiço
1Segunda via de boleto
4Validar user/senha SAC
6Consultar documento
7Consulta de faturas pendentes
8Contratos por cliente
9Conexões por cliente
10Classificações de atendimento
11Processos de atendimentos
16Estrutura de endereços
17Consultar pessoa pelo nome
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 (cd_servico=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 (cd_servico = 9999)

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

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

URL PARA OBTER FATURAS PENDENTES

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

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

URL PARA VALIDAR ACESSO AO SAC

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

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

URL PARA OBTER SEGUNDA VIA DE COBRANÇA

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

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

URL PARA OBTER CONEXÕES PENDENTES

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

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

URL PARA OBTER CONTRATOS PENDENTES

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

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

URL PARA OBTER CLASSIFICAÇÕES DE ATENDIMENTO

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

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

URL PARA OBTER LISTA DE PROCESSO

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

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

URL OBTER A ESTRUTURA DE ENDEREÇOS

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

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 

CONSULTAR PESSOA PELO NOME

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

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


CONSULTAR PESSOA PELO NOME

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

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


CONSULTAR PESSOA PELO NOME

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

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



ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CONSULTA DE CLIENTES POR CÓDIGO

GET /core-api/pessoas/id

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTA DE PLANOS DE ACESSO

IP:PORTA/mk/WSMKListaPlanoAcesso.rule?sys=MK0&token=token&TipoPlano=tipodoplano

GET /planos-acessos/id

Planos acesso - listar por tipo plano

Parâmetros:

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

  • TipoPlano - informar o código conforme tabela:


CódigoTipo do plano
1Internet
2Telefonia
3Hospedagem
4Outros
7Antívirus
8IPTV
9On-Demand
10Transporte
11TV/OTT

Exemplo de saída:

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

LISTAR PLANOS DE ACESSO POR DESCRIÇÃO


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CONSULTA DE PLANOS PELA DESCRIÇÃO

GET /planos-acessos/descricao

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CONSULTA DE PLANOS POR EMPRESA

GET  /planos-acessos/list/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 POR PRODUTO DO CRM


URL PARA CONSULTA DE PLANOS DE ACESSO

IP:PORTA/mk/WSMKConsultaPlanos.rule?sys=MK0&token=token&data_alteracao=&codigo_produto=&codigo_produto_inicio=&codigo_produto_fim=&ativo=&nome_produto=

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 planos 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

URL PARA CONSULTA DE REGRAS DE VENCIMENTO

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

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


URL PARA CONSULTA DA TABELA DE SLA

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


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

URL PARA CONSULTA DAS REGRAS DE BLOQUEIO

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

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


URLA PARA CONSULTAR PROFILES DE PAGAMENTO

IP:PORTA/mk/WSMKListaProfilePagamento.rule?sys=MK0&token=token&CodigoFormaPagamento=codigoformapgto

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


URL PARA CONSULTAR TABELA DE DESCONTO

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

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


URL PARA CONSULTA DE PLANO DE CONTAS

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

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


URL PARA CONSULTAR EQUIPES DE OS

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


Parâmetros:

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

Exemplo de saída:


LISTAR TÉCNICOS RESPONSÁVEIS PARA AS OS


URL PARA LISTAR TÉCNICOS

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

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


URL PARA CONSULTA DE TIPOS DE OS

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

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTAR OS POR CÓDIGO

GET /os/id

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTAR OS POR CÓDIGO

GET /os/pessoa

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


URL PARA CONSULTA DE CONTRATOS POR STATUS

IP:PORTA/mk/WSMKContratosPorClienteV2.rule?sys=MK0&token=token&cd_cliente=&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


URL PARA CONSULTA DE CONEXÕES

IP:PORTA/mk/WSMKConexoesPorClienteV2.rule?sys=MK0&token=token&cd_cliente=&motivo_bloqueio=&bloqueada=


Parâmetros:

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

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

Exemplo de saída:


CONSULTAR CLIENTES POR CÓDIGO


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CONSULTA DE CLIENTES POR CÓDIGO

GET IP:PORTA/pessoas/id

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTA DE CLIENTES POR NOME

GET IP:PORTA/pessoas/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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTA DE CLIENTES POR EMPRESA

GET IP:PORTA/pessoas/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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CONSULTA DE CLIENTES PELO NÚMERO DO CELULAR

GET IP:PORTA/pessoas/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


EXEMPLO DE URL PARA LISTAR SERVIDORES/CONCENTRADORES

GET IP:PORTA/mk/WSMKConexaoServidorConcentrador.rule?sys=MK0&token=&dataConnection=

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


EXEMPLO DE URL PARA LISTAR PLANOS DE ACESSO

GET IP:PORTA/mk/WSMKConexaoPlanoAcesso.rule?sys=MK0&token=&CodigoServidor=

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


EXEMPLO DE URL PARA LISTAR PONTOS DE ACESSO

GET IP:PORTA/mk/WSMKConexaoPontoAcesso.rule?sys=MK0&token=&dataConnection=

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


EXEMPLO DE URL PARA LISTAR IPS

GET IP:PORTA/mk/WSMKConexaoListaIP.rule?sys=MK0&token=&CodigoPontoAcesso=&CodigoServidor=

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CRIAÇÃO DE LOGRADOUROS

POST /logradouros

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA ALTERAÇÃO DE LOGRADOUROS

PUT/logradouros

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


URL PARA CRIAÇÃO DE BAIRRO

POST /core-api/bairros

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs


EXEMPLO DE URL DE ALTERAÇÃO DE BAIRRO

PUT /bairros

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

EXEMPLO DE URL PARA CRIAÇÃO DE CIDADE

POST /cidades

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


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

EXEMPLO DE URL PARA ALTERAÇÃO DE CIDADE

PUT /cidades

Serviço: Cidades - editar

Parâmetros:

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



LISTAR CIDADE POR UF


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

EXEMPLO DE URL PARA LISTAR CIDADE POR ESTADO

IP:PORTA:core-api/cidades/uf?uf=&token=

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)


EXEMPLO

IP:PORTA/mk/WSMKAtendimentos.rule?sys=MK0&token=&data_inicio=

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


IP:PORTA/mk/WSMKAtendentes.rule?sys=MK0&token=&Codigo_atendente=

Parâmetros:

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

LISTAR ATENDIMENTOS POR STATUS


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


Parâmetros:

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

LISTAR CLIENTES POR CÓDIGO


ATENÇÃO

Pré-Requisitos para utilizar esta API:

  • Servidor com Ubuntu na versão 16.04 ou superior
  • Instalação do Node.js no servidor (em caso de dúvida converse com a equipe de atendimento)
  • Recomendamos a utilização do programa Insomnia, veja mais detalhes na nossa documentação Utilizando o Insomnia para consumir as APIs

URL PARA CONSULTA DE CLIENTES POR CÓDIGO

GET /core-api/pessoas/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 CONTRATOS POR PLANO DE ACESSO OU PRODUTO DO CRM


IP:PORTA/mk/WSMKPlanosAcesso.rule?sys=MK0&token=&codigo_plano=&cancelado=&suspenso=&data_adesao_inicial=&data_adesao_final=&aguarda_ativacao=


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)

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


IP:PORTA/mk/WSMKAlterarSenhaSac.rule?sys=MK0&token=&tag=&contrato_ativos=

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:


  • No labels