Lista de webservices aprimorados. Para adquirir ou obter mais informações entre em contato com a nossa equipe comercial.

Pré-requisitos

1. Configuração de perfis de webservices
2. Autorização para consumo dos webservices

ABERTURA DE LEAD

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
  

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKNovaLead

CRIAR PLANOS DE ACESSO

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• descricao - nome do plano de acesso  (Obrigatório)
• mesesContrato - duração do plano de acesso (Obrigatório)
• inativo - S/N (Obrigatório)

• planosAcessoTipoId - informar o código conforme tabela:

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

Exemplo de saída:

Exemplo de uma saída ao chamar o de criação de planos de acesso:

CRIAR NOVO CONTRATO

Parâmetros:

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

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

• CodigoTipoPlano - código do tipo do plano de acesso, preencha conforme os códigos abaixo (Obrigatório)

• CodigoPlanoAcesso - código do plano de acesso. Atenção: se CodigoTipoPlano=12 informar códigos de produtos do CRM  (Obrigatório)

• CodigoRegraVencimento - código da regra de vencimento (Obrigatório)

• CodigoSLA - código da tabela de SLA (Obrigatório caso tenha configuração ativa no sistema)

• IgnorarRenovacaoAutomatica - ativar ou desativar renovação automática do contrato (Opcional)

• ValorSugeridoRenovacao - valor sugerido para a renovação (Opcional)

• CodigoRegraBloqueio - código da régua de bloqueio (Obrigatório)

• DescontoInatividade - código do desconto por inatividade (Opcional)

• CodigoFormaPagamento - código da forma de pagamento (Obrigatório)

• CodigoProfilePagamento - código da profile de pagamento (Obrigatório)

• CodigoMetodoFaturamento - código do método de faturamento (Obrigatório)

• CodigoDescontoAplicado -  código da tabela de descontos (Opcional)

• CodigoPlanoContas - código do plano de contas (Obrigatório)

• ConsultorCRM - código do cadastro de vendedores do CRM (Opcional)
• EmailDst - e-mail do cliente (destinatário) para que receba o e-mail de boas vindas (Obrigatório se 'EnviarBV' for = S)
• EnviarBV - S/N para indicar se o e-mail de boas vindas deve ser enviado, será utilizado o modelo de e-mail e conta default do sistema (Opcional)
• AguardaAtivacao - S/N para indicar se o contrato deve ser criado aguardando ativação (Opcional)

Exemplo de saída:

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

LISTAR FATURAS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• codigo_cliente - código do cadastro do cliente (Obrigatório)
• liquidado - S/N (Opcional)
• codigo_fatura_inicio - código de início da(s) fatura(s) (Opcional)
• codigo_fatura_fim - código de fim da(s) fatura(s) (Opcional)
• tipo_documento - modelo da NF da(s) fatura(s) (Opcional)
• data_emissao - data de geração (Opcional)
• data_vencimento - data de vencimento atual (Opcional)
• data_pagamento - data de liquidação (Opcional)
• codigo_contrato - código do contrato (Opcional)
• data_vencimento_original - data original do vencimento (Opcional)
• codigo_fatura - código da fatura (Opcional)
• quantidade_meses - quantidade de meses após a data de vencimento da fatura, dessa forma serão listadas as faturas dentro do período informado. Caso o parâmetro não seja preenchido o WS considera automaticamente 1 mês (Opcional)

Exemplo de saída:

CRIAR OS

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• CodigoCliente - código do cadastro do cliente (Obrigatório)
• CodigoConexao - código da conexão (Opcional)
• CodigoContrato - código do contrato  (Opcional)
• DescricaoProblema - relato do cliente (Obrigatório)
• CodigoTipoOS - código do tipo de OS (Obrigatório)
• CodigoTecnico - código do técnico responsável (Obrigatório)
• CodigoGrupoServico - código da equipe (Obrigatório)
• CodigoAtendimento - código do atendimento do ERP (Opcional)

• condominio - código do condomínio, se preenchido todos os demais dados do endereço serão preenchidos automaticamente (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

• cidade - código da cidade (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

• bairro - código do bairro (Obrigatório se for informado código de cidade) 🆕 Parâmetro disponível a partir da release 64.9

• logradouro - código do logradouro (Obrigatório se for informado código de cidade) 🆕 Parâmetro disponível a partir da release 64.9

• complemento - texto livre para informação do complemento do endereço (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

• numero - número da casa (Obrigatório se for informado código de cidade) 🆕 Parâmetro disponível a partir da release 64.9

• indicacoes - será adicionado o texto de indicações (possível solução) para a OS (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

🆕 Nesta release, foi inclusa a possibilidade de abrir também ordem de serviço ao provedor. Para isso, pode ser feita a consulta prévia do ponto imobilizado e do local de manutenção:

Parâmetros:

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

Exemplo de saída:

Parâmetros:

• token - token de retorno da autenticação (Obrigatório)
• local - 1 = POP, 2 = Armário, 3 - Ponto de acesso, 4 - OLT, 5 - Servidor, 7 - Caixa de emenda, 6 - Nap/Hub e 99 - Outros

Exemplo de saída:

Parâmetros:

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

Exemplo de saída:

🆕 Parâmetros disponíveis a partir da release 74:

• categoria - 1 indica que vai criar uma O.S. do tipo cliente e 2 indica que vai criar uma O.S. do tipo provedor (Obrigatório)
• protocolo - código do protocolo de atendimento que será vinculado a essa O.S.  (Opcional)

🚨Ao escolher a categoria 2, os seguintes pontos devem ser observados:

🆕 Se o parâmetro CodigoTipoOS for do tipo "ativação" a api vai seguir normalmente, caso não seja, ela pedirá os seguintes parâmetros:

• Imobilizado - código do ponto imobilizado (Obrigatório caso CodigoTipoOS não for de ativação)
• LocalMan - código do local de manutenção: 1 = POP, 2 = Armário, 3 - Ponto de acesso, 4 - OLT, 5 - Servidor, 7 - Caixa de emenda, 6 - Nap/Hub e 99 - Outros(Obrigatório caso CodigoTipoOS não for de ativação)
  
• CodLocalMan - código do ponto de acesso escolhido (Obrigatório caso CodigoTipoOS não for de ativação)

🆕 Se o parâmetro "CodLocalMan" (que se refere ao local da manutenção" estiver preenchido, ele obrigará os parâmetros de endereço referentes ao local.

🆕 Se o parâmetro "TipoItem" for passado, significa que a O.S. receberá itens, então os seguintes campos serão obrigatórios:

• TipoItem - código do tipo de designação do item: 1 - Venda, 2 - Comodato, 3 - Empréstimo, 4 - Demonstração, 5 - Locação, 6 - Serviço, 7 - Imobilizado e 8 - Uso e consumo(Obrigatório caso TipoItem for preenchido)
• SetorItem - código do setor escolhido para movimentação do item(Obrigatório caso TipoItem for preenchido)
• ItemOS - código do produto escolhido(Obrigatório caso TipoItem for preenchido)
• Serial - código do serial do produto (Opcional)
• QtdItem - quantidade de produtos que serão movimentados (Obrigatório caso TipoItem for preenchido)
• vlr_unit - valor do produto que será movimentado (Obrigatório caso TipoItem for preenchido)

  
  

  
  

  Exemplo de saída:

  

  
  

  ALTERAR OS

  
  

  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 OS

  PUT /os

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • id - código da OS (Obrigatório)
  • defeitoReclamado - nova descrição para o defeito reclamado (Opcional)
  • defeitoConstatado - nova descrição para o defeito constatado (Opcional)
  • operador - login (nome do usuário) do operador (Opcional)
  • tipo - código do tipo de OS (Opcional)
  • items - Caso deseje incluir um item em sua OS, deve preencher os seguintes dados: serial (caso o produto seja obrigatória a inclusão), prodServ ("P" para produto e "S" para serviço), quantidade, valorUnitario ( espera o valor unitário do produto que vem da API WSMKConsultaProdutoEstoque do campo venda_un), setor (pode ser buscado usando a API WSMKConsultaProdutoEstoque), subTotal, tipoItem (abaixo os códigos de cada tipo de item), tipoSaida (abaixo os códigos de cada tipo de saída), categoria (categoria da O.S que pode ser 1- cliente 2 - provedor), cod0Item, item

  	tipoItem
  1	Adicional
  2	Pacote
  3	Extra (manual)

  	tipoSaida
  1	Venda
  2	Comodato
  3	Empréstimo
  4	Demonstração
  5	Locação
  9	Serviço
  101	Imobilizado
  102	Uso e consumo

  • assinatura - espera um base64 de uma imagem seja png ou jpeg entre outros diversos formatos, para testar esse campo é possível fazer o envio de uma imagem qualquer para o site https://base64.guru/converter/encode/image e clicando na opção de gerar o código base64, feito isso pasta copiar o código e colocar no insomnia ou Postmann.
  • codigoAtendimentoAssociar - código de atendimento já criado no sistema para que a OS seja vinculada a ele (Opcional)
  • encerrarOs - preencher com S para encerrar a OS no sistema (Opcional)
  • operadorEncerramento - login (nome do usuário) do operador (Obrigatório se 'encerrarOs' for igual a 'S')
  • servicoPrestado - (Obrigatório se 'encerrarOs' for igual a 'S')
  • classificacaoEncerramento - (Obrigatório se 'encerrarOs' for igual a 'S')
  • fecharAtendimentoAssociado - (Obrigatório se 'encerrarOs' for igual a 'S')
  • classificEncerramentoAtendmento - (Obrigatório se 'fecharAtendimentoAssociado' for igual a 'S')
  • classificacaoEncerramento - (Opcional)
  • classificEncerramentoAtendmento - (Opcional)

  
  

  Exemplo de saída:

  

  

  AUTO-DESBLOQUEIO

  
  

  URL PARA AUTO-DESBLOQUEIO

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

  Parâmetros:

  • • token - token de retorno da autenticação (Obrigatório)
    • cd_conexao - Código da conexão (Obtido por WSMKConexoesPorCliente)
    • diasexcecao - quantidade de dias que a conexão ficará desbloqueada (Opcional - caso não seja preenchido será seguida a configuração definida no SAC)

  Exemplo de saída:

  Exemplo de uma saída ao chamar o Webservice WSMKAutoDesbloqueio

  

  
  

  VERIFICAR DISPONIBILIDADE DE PORTAS PRÓXIMAS (VIABILIDADE)

  
  

  URL PARA CONSULTA DE CAIXAS

  IP:PORTA/mk/WSMKVerificaDispPorta.rule?token=token&cd_lead=lead&sys=MK0&lat=latitude&lon=longitude

  
  

  Parâmetros:

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

  • lat - coordenada da latitude (Obrigatório)
  • lon - coordenada da longitude (Obrigatório)

  Exemplo de saída:

  

  
  

  CONSULTAR NOTIFICAÇÃO DE PARADA

  
  

  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 NOTIFICAÇÃO DE PARADA

  GET /notificacoes/status

  Parâmetros:

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

  • status - status da notificação de parada: A para consultar em notificações em andamento e F para finalizadas (Obrigatório)

  Exemplo de saída:

  

  
  

  CONSULTAR CONEXÕES AFETADAS PELA NOTIFICAÇÃO DE PARADA

  
  

  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 PRA CONSULTA DAS CONEXÕES

  GET /notificacoes/conexoes-afetadas

  Parâmetros:

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

  • codigo_parada - código da notificação de parada (Obrigatório)

  Exemplo de saída:

  

  
  

  CONSULTAR OS ABERTAS PARA A NOTIFICAÇÃO DE PARADA

  
  

  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 OS ABERTAS VINCULADAS COM A NOTIFICAÇÃO DE PARADA

  GET /core-api/notificacoes/os-abertas

  Parâmetros:

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

  • codigo_parada - código da notificação de parada (Obrigatório)

  Exemplo de saída:

  

  
  

  CONSULTAR ATENDIMENTOS ABERTOS PARA A NOTIFICAÇÃO DE PARADA

  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 ATENDIMENTOS VINCULADOS COM A NOTIFICAÇÃO DE PARADA

  GET IP:PORTA/notificacoes/atendimentos-abertos

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • codigo_parada - código da notificação de parada (Obrigatório)

  Exemplo de saída:

  

  
  

  
  

  CRIAR CONEXÃO

  
  

  EXEMPLO DE URL PARA CRIAR CONEXÕES

  GET IP:PORTA/mk/WSMKCriarConexao.rule?sys=MK0&token=&CodigoCliente=&CodigoPontoAcesso=&CodigoContrato=&CodigoServidor=&CodigoPlanoAcesso=&CodigoTipoIP=&Tecnologia=&CodigoLead=&AutoDesbloqueio=&CodigoIP=&PoolMKCentral=&PoolDinamico=&MacAddress=&EnderecoCadastro=&TipoConexao=&dataConnection=&Password=&Username=&CodigoCidade=&CodigoEstado=&CodigoBairro=&CodigoLogradouro=&EnderecoNumero=&Complemento=&CEP=

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • CodigoCliente - código do cadastro do cliente (Obrigatório)
  • CodigoPontoAcesso - código do ponto de acesso (Obrigatório)
  • CodigoContrato - código do contrato (Obrigatório)
  • CodigoServidor - código do servidor (Obrigatório)
  • CodigoPlanoAcesso - código do plano de acesso: neste parâmetro é aceito o código de planos de acesso do tipo internet ou o código do plano de internet que estiver dentro do produto do CRM, neste caso o produto deve ser o mesmo da lead vinculada ao contrato (Obrigatório)

  

  • CodigoTipoIP - parâmetro do tipo do IP (Obrigatório)

  Tipo de IP	Parâmetro
  Atribuição	1
  Dinâmico	2
  Requisito	3
  Pool MK	4
  IPV6 Pool	5

  • Tecnologia -  parâmetro da tecnologia da conexão (Obrigatório)

  Tecnologia	Parâmetro
  Wireless	W
  FTTH	F
  UTP	U

  • CodigoLead - código da lead do CRM (Opcional)
  • AutoDesbloqueio - true/false indicando se a conexão permite o auto-desbloqueio (Obrigatório)
  • CodigoIP - (Opcional) obrigatório somente se selecionado TipoIP = 1 - Atribuição 
  • PoolMKCentral - (Opcional)
  • PoolDinamico - (Opcional)
  • macAddress - máscara válida no padrão '00:00:00:00:00:00' (Obrigatório)
  • EnderecoCadastro - (true/false) indicando se a conexão deve ser criada com o endereço geral do cadastro (Obrigatório)
  • TipoConexao - 1 = cobrança ou 2 = cortesia (Obrigatório)  (1 - Cobrança|2 - Cortesia) (1 - Cobrança|2 - Cortesia)
  • dataConnection - nome da multiempresa (Opcional)
  • Password - senha (Obrigatório)
  • Username - usuário (Obrigatório)
  • CodigoCidade - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • CodigoEstado - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • CodigoBairro - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • CodigoLogradouro - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • EnderecoNumero - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • Complemento - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • CEP - (Opcional) Caso não seja informado EnderecoCadastro=true. Todos os códigos relativos a dados do endereço, podem ser obtidos em: WSMKListaEstruturaEnderecos
  • CodCondominio - (Opcional) - código do condomínio:  Os códigos de condomínio, podem ser obtidos em: WSMKListarCondominios

  
  

  • TpAutenticacao - (Opcional) - Código do método de autenticação. Caso não informar parâmetro o padrão será (3- PPPoe Client)

  Tipo de Autenticação	Parâmetro
  Nenhum	1
  Hotspot	2
  PPPoe Client	3
  Ip-Bindings	4
  IPOE	5
  MPLS	6
  BGP	7
  SWAPS	8

  
  

  Exemplo de saída:

  
  

  CRIAR CADASTRO DE CLIENTE (NODE)

  
  

  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 CADASTRO

  POST /pessoas

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • nome - nome do cliente  (Obrigatório)
  • cpf - documento do cliente  (Obrigatório)
  • email - email do cliente (Opcional)
  • classificacao - classificação para o cadastro do cliente  (Obrigatório)
  • nascimento - data de nascimento  (Obrigatório)
  • tipo - tipo de cadastro  (Obrigatório)
  • fone - número do celular  (Obrigatório)
  • estadoId - código do estado  (Obrigatório)
  • estadocobrancaId - código do estado de cobrança (Opcional)
  • bairroId - código do bairro  (Obrigatório)
  • bairroCobrancaId - código do bairro (Opcional)
  • logradouroId - código do logradouro  (Obrigatório)
  • logradouroCobrancaId - código do logradouro de cobrança (Opcional)
  • numero - número do logradouro  (Obrigatório)
  • numerocobranca - número do logradouro (Opcional)
  • cep - CEP do logradouro  (Obrigatório)
  • cepCobranca - CEP do logradouro de cobrança (Opcional)

  
  

  Exemplo de saída:

  

  
  

  CRIAR CADASTRO DE CLIENTE

  
  

  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
  &nome_mae=nomeMae
  &rg=numeroRG
  &user_sac=usuarioSac
  &senha_sac=senhaSac
  

  
  

  Parâmetros: 

  • 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 (Opcional)
  • lon - Longitude do endereço (Opcional)
  • nome_mae - Nome completo da mãe do cliente (Opcional)
  • rg - Número do RG (Opcional)
  • user_sac - Usuário para acessar ao SAC (Opcional)
  • senha_sac - Senha para acessar ao SAC (Opcional)
  • tipo_cadastro - preencher de acordo com o tipo de cadastro que será inserido informando o número 1 - Pessoa física ou 2 - Pessoa jurídica ou 3 - Pré-cadastro (Opcional)
  • grupo_atend - preencher com o código do grupo de atendimento que será vinculado ao cadastro (Opcional)

  • revenda - código da revenda para o cadastro (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  • site - site como texto livre (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  • cfop - 4 dígitos (somente números) para informação do CFOP para notas fiscais 21/22. Atenção: a API vai validar somente se são 4 números, fique atento às configurações fiscais que podem utilizar (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  • cliente_com - 2 dígitos (somente números) para informação do código de cliente para validação de arquivo de notas fiscais 21/22. Atenção: a API vai validar se os códigos inseridos são válidos, fique atento às configurações fiscais que podem utilizar (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  Códigos para informação do parâmetro cliente_com:

  01	Comercial
  02	Industrial
  03	Residencial/Pessoa física
  04	Produtor rural
  05	Orgão adm. pública estadual
  06	Prestador de serviços de telecomunicação
  07	Missões diplomáticas, Repart. Consulares. etc
  08	Igrejas e templos
  99	Outros não especificados

  • whatsapp - S para indicar que o número do celular também é whatsapp (Opcional) 🆕 Parâmetro disponível a partir da release 65

  • codcondominio_cobranca - código do condomínio, se informado os demais dados do endereço de cobrança serão preenchidos automaticamente (Opcional) 🆕 Parâmetro disponível a partir da release 65

  • coduf_cobranca - UF do endereço de cobrança (Opcional) 🆕 Parâmetro disponível a partir da release 65

  Códigos para informação do parâmetro coduf_cobranca:

  1	ACRE
  2	ALAGOAS
  3	AMAPÁ
  4	AMAZONAS
  5	BAHIA
  6	CEARÁ
  7	DISTRITO FEDERAL
  8	ESPÍRITO SANTO
  9	GOIÁS
  10	MARANHÃO
  11	MATO GROSSO
  12	MATO GROSSO DO SUL
  13	MINAS GERAIS
  14	PARÁ
  15	PARAÍBA
  16	PARANÁ
  17	PERNAMBUCO
  18	PIAUÍ
  19	RIO DE JANEIRO
  20	RIO GRANDE DO NORTE
  21	RIO GRANDE DO SUL
  22	RONDÔNIA
  23	RORAIMA
  24	SANTA CATARINA
  26	SERGIPE
  27	TOCANTINS

  • codcidade_cobranca - cidade do endereço de cobrança (Obrigatório se coduf_cobranca for preenchido) 🆕 Parâmetro disponível a partir da release 65

  • codlogradouro_cobranca - código do logradouro de cobrança (Obrigatório se codcidade_cobranca for preenchido) 🆕 Parâmetro disponível a partir da release 65

  • numero_cobranca - número do logradouro (Obrigatório se codcidade_cobranca for preenchido) 🆕 Parâmetro disponível a partir da release 65

  • cep_cobranca - CEP do logradouro de cobrança (Obrigatório se codcidade_cobranca for preenchido) 🆕 Parâmetro disponível a partir da release 65

  • complemento_cobranca - complemento para o endereço de cobrança (Opcional) 🆕 Parâmetro disponível a partir da release 65

  
  

  Exemplo de saída:

  Exemplo de uma saída ao chamar o Webservice WSMKNovaPessoa

  

  

  
  

  PEDIDO DE LIQUIDAÇÃO DE FATURAS 

  Esse serviço prepara para um pedido de liquidação.  

  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

  • O WSMKPedidoLiquidacao:
    • Aceita apenas faturas a receber 
    • Não aceitará faturas excluídas, suspensas e liquidadas 
    • cd_cliente e 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 Perfis de pagamentos por cartão de crédito
  • 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 

    • ValorTotalAcre: Apresenta 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 determinará 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)

    • Saiba mais sobre o cadastro destas condições em Perfis de pagamentos por cartão de crédito

    • O código da condição se encontra onde indicado abaixo 

  • 
    

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

    • Saiba mais sobre o gerenciamento das movimentações de Contas Bancárias em Movimentações de Contas Bancárias

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

  Saída:

  

  O pagamento realizado pela API vai ficar disponível para conciliação no mk erp em Financeiro → Gerenciador de fluxo de caixas → Liquidação via cartão de crédito. Saiba mais em: Liquidações via cartão de crédito

  
  

  CRIAR NOVO ATENDIMENTO

  
  

  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

  POST IP:PORTA/atendimentos

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • pessoaId - código do cliente (Obrigatório)
  • conexaoId - código da conexão do cliente (Opcional)
  • contratoId - código do contrato (Obrigatório)
  • empresaId - código da multiempresa (Obrigatório)
  • processoId - código do processo de atendimento (Obrigatório)
  • classificacaoId - classificação de abertura do atendimento (Obrigatório)
  • infoCliente - informações do cliente (Obrigatório)

  Exemplo de saída:

  

  
  

  
  

  
  

  CRIAR NOVO ATENDIMENTO (COM SELEÇÃO DA ORIGEM DO CONTATO)

  
  

  URL PARA ABERTURA DE ATENDIMENTO

   

  IP:PORTA/mk/WSMKNovoAtendimento.rule?sys=MK0&token=&cd_contrato=&cd_cliente=&cd_processo=&cd_classificacao_ate=&origem_contato=&cd_grupo_visualizadores=&info=&op_abertura=

  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ódigo	Descrição
    1	Email
    2	Outros
    3	Presencial
    4	SAC
    5	Site
    6	Telefônico
    7	Através de um técnico
    8	CRM
    9	Whatsapp
    10	Facebook
    11	Instagram
    12	Messenger
    13	MKBot Assistant
    14	Monitoramento

  • cd_grupo_visualizadores - Código do grupo de visualizadores de acordo com seus cadastros no sistema 
    
  • info - Informação sobre o atendimento
  • op_abertura - login do operador que abriu o atendimento (mesmo login de acesso ao ERP) (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  • conexao_associada - caso o contrato associado possua múltiplas conexões indica o código da conexão que será vinculada ao atendimento (Opcional) 🆕 Parâmetro disponível a partir da release 65

  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.

  • de acordo com parâmetro cd_contrato:

    1. se o contrato possuir somente uma conexão automaticamente ela deve ser associada ao atendimento;

    2. se o contrato possuir múltiplas conexões deve ser considerada a conexão passada no parâmetro;

    3. se o contrato possuir múltiplas conexões e não for passada nenhuma no parâmetro então o atendimento deve ser aberto sem o vínculo;

    4. quando o parâmetro for passado a API vai validar se o código de conexão pertence ao contrato informado.

  
  

  Exemplo de saída:

  

  
  

  DESBLOQUEAR CONEXÃO E RETIRAR DA VELOCIDADE REDUZIDA

  
  

  IP:PORTA/mk/WSMKAutoDesbloqueioV2.rule?sys=MK0&token=&cd_conexao=&diasexcecao=

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_conexao - código da conexão bloqueada ou com a velocidade reduzida devido a inadimplência (Obrigatório)
  • diasexcecao - quantidade de dias que a conexão deve permanecer desbloqueada, se o pagamento não for feito ela será bloqueada novamente (Opcional)

  
  

  Exemplo de saída:

  

  
  

  CRIAR NOVO PRÉ-CADASTRO E ABRIR LEAD DO CRM

  
  

  Pré-Requisitos para utilizar esta API:

  • permissão para que cadastros sejam criados pelo sac plus, app crm+ e apis em Configurações → SAC → Configuração SAC, campo 'Não permitir cadastro de cliente via app sac plus e CRM+' deve estar desmarcado

  
  

  IP:PORTA/mk/WSMKInserirLead.rule?documento=&nome=&fone01=&email=&endereco_lead=&lat=0&lon=0&token=&sys=MK0&informacoes&dataConnection=

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • documento - documento do cliente, caso não seja informado será criado um pré-cadastro (Opcional)
  • nome - razão social do cliente (Obrigatório)
  • fone01 - número do celular (Obrigatório)
  • email - e-mail (Opcional)
  • endereco_lead - endereço que será utilizado na lead e no cadastro, deve ser preenchido exatamente como no exemplo a seguir, separado por barras verticais: sigla do estado|nome da cidade|nome do bairro|nome da rua|número da residência|complemento opcional|CEP (Obrigatório)
  • lat - latitude para a lead (Opcional)
  • lon - longitude para a lead (Opcional)
  • dataConnection - nome da multiempresa (Opcional)

  Exemplo de saída:

  

  
  

  RESERVAR PORTAS DO MAPS EM UMA LEAD

  
  

  IP:PORTA/mk/WSMKReservarPorta.rule?token=&cd_lead=&periodo_reserva=&sys=MK0

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_lead - código da lead para fazer a reserva da porta (Obrigatório)
  • periodo_reserva - quantidade de dias em que deve ser gerada a reserva da porta, se não for preenchido é seguido o padrão do sistema: 7 dias (Opcional)

  GERAR LINHA DE PAGAMENTO POR PIX (CHAVE PIX COPIA E COLA)

  Pré-requisitos:

  • MK4
  • Release 109.53 ou superior
  • Profile com PIX em produção

  
  

  IP:PORTA/mk/WSMKRetornarCopieColaPix.rule?sys=MK0&token=&Documento=&CodigoFatura=&CodigoCliente=

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • Documento - CPF ou CNPJ do cliente (Opcional)
  • CodigoFatura - código da fatura (Opcional)
  • CodigoCliente - código do cliente (Opcional)

  Pelo menos um dos parâmetros opcionais deve ser preenchido. Caso sejam utilizados os parâmetros de Documento ou CodigoCliente a API vai gerar a chave de pagamento Pix da fatura com vencimento mais próximo, ou em caso de cliente inadimplente da que estiver vencida a mais tempo.

  Exemplo de saída:

  

  Neste retorno a API informa os seguintes status:

  • conexão_reduzida - Não = conexão desbloqueada, Sim = conexão bloqueada ou em redução de velocidade
  • status_contrato - Não = contrato ativo, Sim = contrato cancelado

  ACEITE DE CONTRATO COM ENVIO DE SELFIE E ASSINATURA

  Pré-requisitos:

  • sistema atualizado na release nº 56 ou superior;
  • termos de contrato habilitados com aceite, envio de selfie e assinatura (veja mais em Cadastro dos Termos de um Aceite de Contrato);

  A API é do tipo POST:

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

  Como esta API faz o envio de imagens (selfie e assinatura) também é necessário inserir dados no Body no formato form-data:

  

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • contrato - código do contrato do cliente (Obrigatório)
  • selfie - imagem da selfie (Obrigatório)
  • assinatura - imagem da assinatura (Obrigatório)

  Para fazer o envio das imagens é necessário alterar o padrão de Text para File:

  

  Será mostrada então a opção Select Files para que seja feito o upload da imagem:

  

  Exemplo de saída:

  • se o contrato não tiver termos de aceite ou não tiver nenhum pendente de aceite:

  

  • se o contrato estiver com os termos OK:

  

  Registro no contrato do cliente:

  

  
  

  CADASTRAR CARTÃO DE CRÉDITO

  Pré-requisitos:

  • sistema atualizado na release nº 57 ou superior;
  • integração com operadora de cartão de crédito ativa e em produção. Saiba mais em Pagamento via E-commerce (Cartão de Crédito).

  A API é do tipo POST:

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

  Onde:

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

  No body da requisição devem ser inseridos os dados do cartão de crédito:

  

  • portador - nome do portador do cartão de crédito (Obrigatório)
  • mm - mês de validade do cartão de crédito (Obrigatório)
  • aa - ano de validade do cartão de crédito, deve ser preenchido no formato AAAA (Obrigatório)
  • cvv - CVV do cartão de crédito (Obrigatório)
  • doc - CPF ou CNPJ do portador (Obrigatório)
  • numero - número do cartão de crédito (Obrigatório)
  • debito_auto - S/N: para ativar ou não a recorrência (débito automático) no cartão de crédito (Obrigatório)
  • cd_cliente - código do cadastro do cliente (Obrigatório)
  • ativo - S/N: para ativar ou não o cartão de crédito pela API (Obrigatório)

  Exemplo de saída:

  • Se for ativada a recorrência o retorno vai iniciar listando as faturas em que foi incluído o débito agendado:

  

  • E após os dados do cliente e número do cartão (conforme padrão de segurança do mk erp e da Cielo ele é tokenizado no banco de dados, por isso somente dígitos iniciais e finais são informados):

  

  • Conforme requisitos da Cielo por questões de segurança podem ser realizadas 3 tentativas por dia (24h) de cadastro de novo cartão de crédito. Exemplo de retorno quando este limite é ultrapassado:

  

  CONSULTAR CARTÃO DE CRÉDITO POR CLIENTE

  Pré-requisitos:

  • sistema atualizado na release nº 57 ou superior;
  • integração com operadora de cartão de crédito ativa e em produção. Saiba mais em Pagamento via E-commerce (Cartão de Crédito).

  
  

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

  Onde:

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

  Exemplo de saída:

  

  
  

  ATIVAR/DESATIVAR CARTÃO DE CRÉDITO E RECORRÊNCIA

  Pré-requisitos:

  • sistema atualizado na release nº 57 ou superior;
  • integração com operadora de cartão de crédito ativa e em produção. Saiba mais em Pagamento via E-commerce (Cartão de Crédito)

  A API é do tipo POST:

  IP:PORTA/mk/WSMKAlterarCartao.rule?token=&sys=MK0&cd_cartao=&ativar=&recorencia=

  Onde:

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

  No body da requisição devem ser inseridos os dados do cartão de crédito que será alterado:

  • cd_cartao - código do cartão de crédito que será alterado, é obtido pela API WSMKConsultarCartao (Obrigatório)
  • ativar - S/N para ativar/desativar o cartão de crédito (Obrigatório)
  • recorencia - S/N para ativar/desativar a recorrência do cartão de crédito (Obrigatório)

  
  

  Exemplo de saída:

  • Desativar a recorrência:

  

  • Desativar o cartão de crédito:

  

  • Ativar cartão de crédito:

  

  • Ativar recorrência do cartão de crédito:

  

  

  
  

  INSERIR COMENTÁRIOS EM ATENDIMENTOS

  Pré-requisitos:

  • sistema atualizado na release nº 60 ou superior

  IP:PORTA/mk/WSMKAtendimentoComentario.rule?sys=MK0&token=&cd_atendimento=&comentario=

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_atendimento - código do atendimento em que será inserido o comentário (Obrigatório)
  • comentario - texto do comentário do atendimento (Obrigatório)

  • user - login do usuário do operador que registrou o comentário para que fique visível no ticket do atendimento, a API valida se o usuário está cadastrado no ERP (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  • tipo - tipo do comentário: 1 para privado ou 2 para público, se não informado a API vai inserir como privado (Opcional) 🆕 Parâmetro disponível a partir da release 64.9

  Exemplo de saída:

  

  Caso o código de atendimento informado não exista, ou seja referente a um atendimento encerrado o retorno será:

  

  Exemplo de comentário no mk erp:

  

  ATIVAR CONTRATOS

  Pré-requisitos:

  • sistema atualizado na release nº 61 ou superior
  • contratos criados com a opção 'Aguardando ativação'
  • método de faturamento 'Gerar uma fatura para cada conta' ou 'Permitir agrupamento de contas e faturas'

  IP:PORTA/mk/WSMKAtivarContrato.rule?token=&contrato=&observacao=&sys=MK0

  Onde:

  • token - token de retorno da autenticação (Obrigatório)
  • contrato - código do contrato que está aguardando a ativação (Obrigatório)
  • observacao - texto livre para inserir observações no contrato (Opcional)

  Exemplo de saída:

  

  
  

  
  

  ALTERAR CADASTROS DE CLIENTES

  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 ALTERAR CADASTRO

  PUT /pessoas

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • id - código do cadastro do cliente (Obrigatório)
  • tipo - código do tipo de cliente (Opcional)
  • email - novo email do cliente (Opcional)
  • classificacao - nova classificação para o cliente (Opcional)
  • nascimento - data de nascimento no formato AAAA-MM-DD, exemplo: 1991-06-04 (Opcional)
  • fone - novo número do celular no formato DDD+número, exemplo: 51999999999 (Opcional)
  • estadoId - novo estado (endereço geral) (Opcional)
  • estadoCobrancaId - novo estado (endereço de cobrança) (Opcional)
  • cidadeId - nova cidade (endereço geral) (Obrigatório se alterado estadoId)
  • cidadeCobrancaId - nova cidade (endereço de cobrança) (Obrigatório se alterado estadoCobrancaId)
  • bairroId - novo bairro (endereço geral) (Obrigatório se alterado cidadeId)
  • bairroCobrancaId - novo bairro (endereço de cobrança) (Obrigatório se alterado cidadeCobrancaId)
  • logradouroId - novo logradouro (endereço geral) (Obrigatório se alterado bairroId)
  • logradouroCobrancaId - novo logradouro (endereço de cobrança) (Obrigatório se alterado bairroCobrancaId)
  • numero - novo logradouro (endereço geral) (Opcional)
  • numeroCobranca - novo logradouro (endereço de cobrança) (Opcional)
  • cep - novo CEP geral, atenção: a troca do CEP não altera os demais dados do endereço do cadastro (Opcional)
  • cepCobranca - novo CEP do endereço de cobrança, atenção: a troca do CEP não altera os demais dados do endereço do cadastro (Opcional)

  

  PROCESSO DE LIQUIDAÇÃO DE FATURAS V2

  CONSULTAR PESSOA PELO NOME

  IP:PORTA/mk/WSMKLiquidacaoFaturasV2.rule?sys=MK0&token=tokenRetornoAutenticacao&IDPagamento=IDPagamento&forma_pagto=CondicaoPagamento&conta=contaBanco&valor_total=valorTotal&valor_acrescimo=valorAcrescimo&valor_desconto=valorDesconto&data_recebimento=dataRecebimento

  Onde: 

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

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

  • forma_pagto- Código da condição de pagamento escolhido para a liquidação (3 = cartão de crédito / 4 = depósito/ 101 = pix) (Obrigatório)

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

  • valor_total - Valor total da fatura (Obrigatório)
  • valor_acrescimo - Valor de acréscimo da fatura (Opcional)
  • valor_desconto - Valor do desconto da fatura (Opcional)
  • data_recebimento - Data do recebimento da fatura (Obrigatório)

  Saída:

  

  
  

  CONSULTA DE CONTAS BANCÁRIAS

  CONSULTAR PESSOA PELO NOME

  IP:PORTA/mk/WSMKConsultaContasBancarias.rule?sys=MK0&token=tokenRetornoAutenticacao&descricao=nomeContaBancaria

  Onde: 

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

  • descricao- nome da conta bancária (Opcional)

  Saída sem descrição:

  

  
  

  Saída com descrição:

  

  
  

  ALTERAR CONEXÃO

  
  

  IP:PORTA/mk/WSMKAlterarConexao.rule?sys=MK0&token=&cd_conexao=&auto_desbloq=&ignorar_bloqueio=&tipo_conexao=&username=&senha_conexao=&desconectar_conexao=&motivo_desconexao=

  Onde: 

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

  • cd_conexao - código da conexão que será alterada (obrigatório)
  • auto_desbloq - S/N para ativar/desativar a permissão de auto-desbloqueio na conexão (opcional)
  • ignorar_bloqueio - S/N para que a conexão ignore o bloqueio (opcional)
  • tipo_conexao - 1 ou 2, cobrança ou cortesia (opcional)
  • username - alterar username da conexão (opcional)
  • senha_conexao - alterar senha da conexão (opcional)
  • desconectar_conexao - S/N para derrubar a conexão após as alterações (opcional)
  • motivo_desconexao - motivo que será utilizado para a desconexão (opcional)

  • bloquear - se informado S a conexão deve ser bloqueada (opcional) Novidade! Disponível na release 64.4 ou superior

  • motivo_bloqueio - código do motivo de bloqueio conforme lista abaixo (obrigatório se bloquear=S) Novidade! Disponível na release 64.4 ou superior

    • 1 - Falta Pagamento

    • 3 - Por tempo indeterminado

    • 5 - Contrato não aceito

  • obs_bloqueio - texto livre para observações do bloqueio (opcional) Novidade! Disponível na release 64.4 ou superior

  Saída:

  

  
  

  ALTERAR STATUS DO CONTRATO

  
  

  IP:PORTA/mk/WSMKContratoAlterarStatus.rule?sys=MK0&token=Operacao=&Contrato=&Observacao=&CodigoMotivoSuspensao=&CodigoMotivoCancelamento=&BloquearConexao=&DataBloqueioConexao=&GerarProporcional=&InativarCliente=&DataReativacaoContrato=&RemoverContas=

  Onde:

  • token -  token de retorno da autenticação (Obrigatório)
  • Operacao - preencher de acordo com a operação: SUSPENDER ou CANCELAR ou ATIVAR (obrigatório)
  • Contrato - código do contrato que será alterado (obrigatório)
  • Observacao - texto para ser utilizado como motivo da suspensão (obrigatório se 'Operacao' for 'SUSPENDER')
  • CodigoMotivoSuspensao - código do motivo de suspensão, obtido por WSMKConsultaMotivoSuspensao (opcional)
  • CodigoMotivoCancelamento - código do motivo de cancelamento, obtido por WSMKConsultaMotivoCancelamento (opcional)
  • BloquearConexao - S/N para indicar se a alteração deve bloquear a conexão (opcional)
  • DataBloqueioConexao - se não for preenchido o bloqueio será imediato (opcional)
  • GerarProporcional - indica se deve ser gerada fatura com valor proporcional quando operação for de cancelamento (opcional)
  • InativarCliente - indica se o cadastro do cliente deve ser inativado quando operação for de cancelamento (opcional)
  • DataReativacaoContrato - data para reaivação do cadastro se a operação for de suspensão (opcional)
  • RemoverContas - indica se as contas não liquidadas do contrato devem ser removidas se a operação for de cancelamento (opcional)

  Saídas:

  

  

  

  
  

  ALTERAR STATUS DE FATURAS

  
  

  IP:PORTA/mk/WSMKAlteraStatusFaturas.rule?sys=MK0&token=&suspender=&motivo_suspensao=&observacoes=&faturas=

  Onde:

  • token -  token de retorno da autenticação (Obrigatório)
  • suspender - S/N para indicar se a fatura deve ser suspensa ou retirada da suspensão (Obrigatório)
  • motivo_suspensao - código do motivo de suspensão que será utilizado (Obrigatório se 'suspender' = 'S')
  • observacoes - texto livre para indicar observações para a operação (Opcional)
  • faturas - código da(s) fatura(s), para indicar múltiplas basta separar por vírgulas (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

  BUSCAR CONTRATOS POR DOCUMENTO

  🆕 API disponível a partir da release 64.9

  IP:PORTA/mk/WSMKconsultaContratoDoc.rule?sys=MK0&token=&doc=&user_sac=&pass_sac=

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

  • doc - CPF ou CNPJ do cliente (Obrigatório)

  • user_sac - Usuário do SAC (Opcional)

  • pass_sac - Senha do SAC (Opcional)

  
  

  Exemplo de saída:

  

  
  

  
  

  ALTERAÇÃO DO ENDEREÇO DE COBRANÇA

  🆕 API disponível a partir da release 72

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

  
  

  Parâmetros:

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

  
  

  No body da requisição devem ser inseridos os dados do endereço de cobrança:

  • cd_pessoa - código do Cadastro de pessoas (Obrigatório)
  • igual_residencia - marca a opção "Endereço de cobrança igual ao endereço de instalação" e replica no endereço de cobrança o endereço de instalação (Obrigatório)
  • cep - conforme cadastro de endereços (Obrigatório)
  • cd_estado - conforme cadastro de endereços (Obrigatório)
  • cd_cidade - conforme cadastro de endereços (Obrigatório)
  • cd_bairro - conforme cadastro de endereços (Obrigatório)
  • cd_pais - conforme cadastro de endereços (Opcional)
  • cd_logradouro - conforme cadastro de endereços (Obrigatório)
  • complemento - (Opcional)
  • numero - (Obrigatório)
  • referência - (Opcional)

  
  

  { "cd_pessoa":18618, "igual_residencia":"N", "cep":"95.588-000", "cd_estado":1, "cd_cidade":3548790, "cd_bairro":1209, "cd_pais":1, "cd_logradouro":3405, "complemento":"teste complemento", "numero":50, "referencia":"teste" }

  
  

  Ao utilizar a opção "igual_residencia" = "S" não é necessário informar os demais parâmetros (atente-se ao preenchimento no seguinte formato):

  
  

  { "cd_pessoa":18618, "igual_residencia":"S", "cep":"", "cd_estado":null, "cd_cidade":null, "cd_bairro":null, "cd_pais":null, "cd_logradouro":null, "complemento":"", "numero":null, "referencia":"" }

  
  

  Exemplo de saída:

  
  

  

  
  

  
  

  ALTERAÇÃO DO ENDEREÇO DE CONEXÃO

  🆕 API disponível a partir da release 72

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

  Parâmetros:

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

  
  

  No body da requisição devem ser inseridos os dados do endereço da conexão:

  • cd_conexao - código da conexão no menu Técnico (Obrigatório)
  • igual_residencia - replica na conexão o endereço de instalação (Obrigatório)
  • cep - conforme cadastro de endereços (Obrigatório)
  • cd_estado - conforme cadastro de endereços (Obrigatório)
  • cd_cidade - conforme cadastro de endereços (Obrigatório)
  • cd_bairro - conforme cadastro de endereços (Obrigatório)
  • cd_pais - conforme cadastro de endereços (Opcional)
  • cd_logradouro - conforme cadastro de endereços (Obrigatório)
  • complemento - (Opcional)
  • numero - (Obrigatório)
  • referência - (Opcional)

  
  

  { "cd_conexao":18618, "igual_residencia":"N", "cep":"95.588-000", "cd_estado":1, "cd_cidade":3548790, "cd_bairro":1209, "cd_pais":1, "cd_logradouro":3405, "complemento":"teste complemento", "numero":50, "referencia":"teste" }

  Ao utilizar a opção "igual_residencia" = "S" não é necessário informar os demais parâmetros (atente-se ao preenchimento no seguinte formato):

  { "cd_conexao":18618, "igual_residencia":"S", "cep":"", "cd_estado":null, "cd_cidade":null, "cd_bairro":null, "cd_pais":null, "cd_logradouro":null, "complemento":"", "numero":null, "referencia":"" }

  Exemplo de saída:

  
  

  

  
  

  
  

  AGENDAMENTO DE ORDEM DE SERVIÇO

  🆕 API disponível a partir da release 72

  IP:PORTA/mk/WSMKAgendamentoOrdem.rule?sys=MK0&token=&codigoOS=&tecnico=&data_hora_inicio=&data_hora_fim=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • codigoOS - código da ordem de serviço ainda não agendada (Obrigatório)
  • tecnico - código do colaborador cadastrado no ERP (Obrigatório)
  • data_hora_inicio - data e hora que o compromisso deve ser iniciado no formato DD/MM/AAAA HH/MM/SS (Obrigatório)
  • data_hora_fim - data e hora que o compromisso deve ser finalizado no formato DD/MM/AAAA HH/MM/SS (Obrigatório)

  
  

  Paramêtros adicionados na release nº 73:

  • CodAgendaGrupo - código da equipe de O.S. selecionada (Opcional)

  
  

  Exemplo de saída:

  
  

  
  

  

  
  

  
  

  ALTERAÇÃO DA TITULARIDADE

  🆕 API disponível a partir da release 72

  IP:PORTA/mk/WSMKAlteracaoTitularidade.rule?sys=MK0&token=&CodigoContrato=&CodNovoCliente=&InativarCliAntigo=&MotivoInatividade&GerarUsuárioSac=&NovoTermoContratual=&AbrirOSdeEquipamentos=&TipoOS&GrupoAtendimento&TecnicoResponsável&Defeito_associado&Indicacoes

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • CodigoContrato - código do contrato que será feita a troca de titularidade (Obrigatório)
  • CodNovoCliente - código do novo cliente para onde será alterado o contrato (Obrigatório)
  • InativarCliAntigo - indica se deve inativar o cliente antigo S ou N (Obrigatório)
  • MotivoInatividade - código do motivo de inatividade escolhido para a ação (Obrigatório caso utilizar a opção acima)
  • GerarUsuárioSac - indica se deve ser gerado novo usuário e senha de sac - S ou N (Opcional)
  • NovoTermoContratual - indica se deve ser gerado um novo termo contratual para o contrato - S ou N (Opcional)
  • AbrirOSdeEquipamentos - indica se deve abrir ordem de serviço para retirada de equipamento - S ou N (Opcional)
  • TipoOS - código do tipo de ordem de serviço que deve ser aberta (Obrigatório caso utilizar a opção acima)
  • GrupoAtendimento - código da equipe de O.S. para a qual será disponibilizada a ordem de serviço (Obrigatório caso utilizar a opção AbrirOSdeEquipamentos)
  • TecnicoResponsável - código do técnico responsável pela prestação do serviço (Opcional)
  • Defeito_associado - código do defeito associado na ordem de serviço (Opcional)
  • Indicacoes - campo texto livre (Opcional)

  
  

  Exemplo de saída:

  

  
  

  
  

  ALTERAÇÃO DA REGRA DE VENCIMENTO DO CONTRATO DO CLIENTE

  🆕 API disponível a partir da release 72

  
  

  Essa api depende de uma consulta prévia das faturas disponíveis para alteração do contrato selecionado (são excluídas faturas suspensas, liquidadas e com documentos fiscais gerados):

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

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • CodigoContrato - código do contrato que será feita a consulta das faturas (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

  Com essa consulta, então deve ser consumida a segunda api para alterar a regra de vencimento:

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

  Parâmetros:

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

  
  

  No body da requisição devem ser inseridos os dados das faturas e da regra de vencimento:

  • codfaturamentoregra - código da regra de faturamento escolhida (Obrigatório)
  • cd_contrato - código do contrato (Obrigatório)
  • observacao - texto livre (Opcional)
  • atualizarDataDesconto - S ou N (Opcional)

  
  

  { "contas": [ { "cd_conta": 140561, "cd_fatura": 126054, "codigo": 64838, "hash": "953db6f527573249f2773dcea9ab1cf4.154364", }, { "cd_conta": 140562, "cd_fatura": 126055, "codigo": 64839, "hash": "953db6f527573249f2773dcea9ab1cf4.154364" } ], "codfaturamentoregra":82, "cd_contrato":4584, "observacao":"ok", "atualizarDataDesconto":"S" }

  Exemplo de saída:

  

  ATUALIZAÇÃO DO PLANO DE ACESSO DO CONTRATO

  🆕 API disponível a partir da release 72

  
  

  Essa api depende de uma consulta prévia das faturas disponíveis para alteração do contrato selecionado (são excluídas faturas suspensas, liquidadas e com documentos fiscais gerados):

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

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • CodigoContrato - código do contrato que será feita a consulta das faturas (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

  Com essa consulta, então deve ser consumida a segunda api para alterar o plano de acesso:

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

  Parâmetros:

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

  
  

  No body da requisição devem ser inseridos os dados das faturas e da regra de vencimento:

  • cd_contrato - código do contrato (Obrigatório)
  • novoValor - novo valor que será informado no contrato (Opcional)
  • dataBaseFidelidade - nova data base de fidelidade do contrato (Obrigatório)
  • gerarRestante - S ou N (Opcional)
  • novoPlano - código do novo plano de acesso (Obrigatório)
  • gerarProporcional - S ou N (Opcional)
  • tabelaDesconto - código da tabela de desconto informada (Opcional)
  • obsAdicionais - texto livre (Opcional)

  
  

  { "faturas": [ { "Contas": [ { "cd_conta": 391842, "cd_fatura": 326800, "codigo": 51641, "data_vencimento": "2025-08-01", "descricao": "Alteração autorizada.", "hash": "b81e41d9a0846ead12003c9b4a576a8b.781250", "ok": "Sim" }, { "cd_conta": 391843, "cd_fatura": 326801, "codigo": 51642, "data_vencimento": "2025-09-01", "descricao": "Alteração autorizada.", "hash": "b81e41d9a0846ead12003c9b4a576a8b.781250", "ok": "Sim" } ], "cd_contrato": 4001, "novoValor": "1000", "dataBaseFidelidade": "2026-07-01", "gerarRestante": "N", "novoPlano": 6, "gerarProporcional": "S", "tabelaDesconto": 5, "obsAdicionais": "teste api2" } ] }

  
  

  Exemplo de saída:

  
  

  

  
  

  
  

  ALTERAR PRODUTO DO CRM DO CONTRATO

  🆕 API disponível a partir da release 73

  
  

  Essa api depende de uma consulta prévia das faturas disponíveis para alteração do contrato selecionado (são excluídas faturas suspensas, liquidadas e com documentos fiscais gerados):

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

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • CodigoContrato - código do contrato que será feita a consulta das faturas (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

  Com essa consulta, então deve ser consumida a segunda api para alterar o plano de acesso:

  IP:PORTA/mk/WSMKAlterarProdCRM.rule?sys=MK0&token=&cd_contrato=&cd_produto=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_contrato - código do contrato selecionado para execução (Obrigatório)
  • cd_produto - código do produto do CRM selecionado (Obrigatório)

  
  

  { "faturas": [ { "Contas": [ { "cd_conta": 401959, "cd_fatura": 335115, "codigo": 52169, "data_vencimento": "2025-01-08", "descricao": "Alteração autorizada.", "hash": "f59fe4ca13b203bad355bb71ff3f7a1d.138089", "ok": "Sim" }, { "cd_conta": 401960, "cd_fatura": 335116, "codigo": 52170, "data_vencimento": "2025-02-10", "descricao": "Alteração autorizada.", "hash": "f59fe4ca13b203bad355bb71ff3f7a1d.138089", "ok": "Sim" }, { "cd_conta": 401961, "cd_fatura": 335117, "codigo": 52171, "data_vencimento": "2025-03-10", "descricao": "Alteração autorizada.", "hash": "f59fe4ca13b203bad355bb71ff3f7a1d.138089", "ok": "Sim" } ], "novoValor": "1000", "dataBaseFidelidade": "2026-07-01", "gerarRestante": "N", "gerarProporcional": "S", "tabelaDesconto": 5, "obsAdicionais": "teste api2" } ] }

  
  

  Exemplo de saída:

  
  

  

  
  

  
  

  REMOVER O AGENDAMENTO E REAGENDAR ORDEM DE SERVIÇO

  🆕 API disponível a partir da release 74

  
  

  IP:PORTA/mk/WSMKCancelarReagendarOrdem.rule?sys=MK0&token=&codigoOS=&cancelar_os=&data_hora_inicio=&data_hora_fim=&reagendar_os=&Tecnico=&CodAgendaGrupo=

  
  

  Parâmetros:

  • codigoOS - código da ordem de serviço que será alterada (Obrigatório)
  • cancelar_os - S ou N (Obrigatório)
  • data_hora_inicio - data e hora do inicialização do próximo agendamento (Obrigatório ao utilizar a opção reagendar_os = S)
  • data_hora_fim - data e hora de finalização do próximo agendamento (Obrigatório ao utilizar a opção reagendar_os = S)
  • reagendar_os - S ou N (Obrigatório)
  • Tecnico - código do técnico escolhido (Opcional)
  • CodAgendaGrupo - código da equipe de O.S. escolhida (Opcional)

  
  

  🚨Atenção: ao marcar a opção reagendar_os = S e não informar técnico e equipe, será reagendado para o técnico e a equipe originais.

  
  

  Exemplos de saída:

  
  

  

  
  

  

  
  

  
  

  CRIAR CADASTRO DE USUÁRIO

  🆕 API disponível a partir da release 74

  Essa api depende de uma consulta prévia dos perfis de acesso, grupos disponíveis e revendas:

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

  
  

  Parâmetros:

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

  
  

  Exemplo de saída:

  

  
  

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

  
  

  Parâmetros:

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

  
  

  Exemplo de saída:

  

  
  

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

  
  

  Parâmetros:

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

  
  

  Exemplo de saída:

  

  
  

  IP:PORTA/mk/WSMKCadastroDeUsuario.rule?sys=&Token=&Login=&Senha=&NomeUsuario=&Email=&LimiteSenha=&SetorPrincipal=&AdmGeral=&AdmSAC=&LogarTodas=&Celular=&Grupo=&cd_revenda=&PerfilAcesso=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • Login - login do usuário (Obrigatório)
  • Senha - senha do usuário respeitando o mesmo formato do ERP: ao menos 8 caracteres, sendo letras (ao menos uma maiúscula) e números (Obrigatório)
  • NomeUsuario - nome do usuário registrado no ERP (Obrigatório)
  • Email - endereço de email do usuário (Obrigatório)
  • LimiteSenha - N (Nunca expira), E (Expira em determinado número de dias) e T (Troca de senha a cada número de dias) (Obrigatório)
  • SetorPrincipal - ADM (Administrativo), TEC (Técnico), FIN (Financeiro), ATE (Atendimento) e OUTROS (Obrigatório)
  • AdmGeral - S ou N (Obrigatório)
  • AdmSAC - S ou N (Obrigatório)
  • LogarTodas - S ou N (Opcional)
  • Celular - número de celular (Obrigatório)
  • Grupo - código do grupo de permissão de acesso (Opcional)
  • cd_revenda - código da revenda de acesso do usuário (Opcional)
  • PerfilAcesso - código do perfil de acesso do usuário (Opcional)

  
  

  Exemplo de saída:

  

  
  

  CRIAR CADASTRO DE TÉCNICO

  🆕 API disponível a partir da release 74

  IP:PORTA/mk/WSMKCadastroDeTecnico.rule?sys=MK0&Token=&Colaborador=&Nivel=&Usuario=&BaseOperacional=&CodCidade=&CodArea=&tipo=&CodTurno==

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • Colaborador - Código de cadastro (a mesma precisa ter um cadastro com o tipo cliente + funcionário) (Obrigatório)
  • Nivel - Qual o nível de seu técnico, pode ser usado as seguintes opções: 1, 2 ou 3 (Obrigatório)
  • Usuario - Código do usuário de acesso ao ERP (Obrigatório)
  • BaseOperacional - Código da base que irá pertencer ao seu técnico (Obrigatório)
  • CodCidade - Código da cidade que o técnico irá atuar (Obrigatório)
  • CodArea - Código da área que o técnico irá atuar (Obrigatório)
  • tipo - Deve selecionar o tipo 'P' (prefencial) ou 'E' (exclusivo) (Obrigatório)
  • CodTurno - Código do turno de trabalho de seus técnicos (Opcional)

  
  

  Exemplo de saída:

  

  
  

  
  

  LIMPAR MAC

  🆕 API disponível a partir da release 74

  IP:PORTA/mk/WSMobileTrocaMacOS.rule?sys=MK0&token=&cd_os=&mac_add=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_os - número da O.S. com a conexão associada (Obrigatório)
  • mac_add - nova numeração do mac: para limpar e deixar o sistema obter de forma automática deve ser enviado no formato 00:00:00:00:00:00 (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

  
  

  PROVISIONAR EQUIPAMENTOS

  🆕 API disponível a partir da release 74

  
  

  Essa api depende de uma consulta prévia das caixas, das portas, dos scripts de caixas e do modelo de ONU:

  IP:PORTA/MK/WSMKProvisionarEquipamentoV4Caixas.rule?sys=MK0&token=&Latitude=&Longitude=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • Latitude - Exemplo a ser inserido → -21.45102153 (Obrigatório)
  • Longitude - Exemplo a ser inserido → -41.5421321451 (Obrigatório)

  Exemplo de saída:

  

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

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_splitter - código da CTO escolhida (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

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

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • cd_splitter - código da CTO escolhida (Obrigatório)

  
  

  Exemplo de saída:

  

  
  

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

  
  

  Parâmetros:

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

  
  

  Exemplo de saída:

  

  
  

  🚨 Atenção: A api de consulta de modelo de ONU obtém os modelos disponíveis para cada um dos fabricantes cadastrados no ERP, em casos em que o equipamento for Fiberhome é necessário informar o modelo, nos demais pode ser utilizado um modelo padrão que não haverá impacto na execução.

  
  

  IP:PORTA/mk/WSProvisionarEquipamentoV3.rule?sys=MK0&token=&serial=&codconexao=&modelo=&caixa=&porta=&cdprovisionamento=

  
  

  Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • serial - serial do equipamento escolhido (Obrigatório)
  • modelo - modelo do equipamento (Obrigatório)
  • caixa - id da caixa escolhida (Obrigatório)
  • porta - código da porta a ser provisionada (Obrigatório)