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

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

Índice

Pré-requisitos

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






ABERTURA DE LEAD


URL PARA ABERTURA DE LEAD

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

Onde: 

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

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKNovaLead



CRIAR PLANOS DE ACESSO


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 PLANOS DE ACESSO

POST /planos-acessos

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:


    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 de criação de planos de acesso:



CRIAR NOVO CONTRATO


URL PARA CRIAÇÃO DE NOVO CONTRATO

IP:PORTA/mk/WSMKNovoContrato.rule?sys=MK0&token=tokenretornoautenticação&CodigoCliente=codpessoa&CodigoTipoPlano=tipoplano&CodigoPlanoAcesso=codplano&CodigoRegraVencimento=vcto&CodigoSLA=sla&IgnorarRenovacaoAutomatica&ValorSugeridoRenovacao=vlrrenova

&CodigoRegraBloqueio=regbloq&DescontoInatividade&CodigoFormaPagamento=formapgto&CodigoProfilePagamento=profile&CodigoMetodoFaturamento=metodofat&CodigoDescontoAplicado&CodigoPlanoContas=planocontas

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 (Obrigatório)

  • CodigoPlanoAcesso - código do plano de acesso (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)

Exemplo de saída:

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

LISTAR FATURAS


URL PARA CONSULTA DE FATURAS

IP:PORTA/mk/WSMKFaturas.rule?sys=MK0&token=token&codigo_cliente=&liquidado=true&codigo_fatura_inicio&codigo_fatura_fim&codigo_documento&tipo_documento&data_emissao&data_vencimento=&data_pagamento&codigo_contrato=&data_vencimento_original&codigo_fatura=&quantidade_meses=

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


URL PARA ABRIR NOVA OS

IP:PORTA/mk/WSMKCriarOrdemServico.rule?sys=MK0&token=token&CodigoCliente=&CodigoConexao=&CodigoContrato=&DescricaoProblema=&CodigoTipoOS=&CodigoTecnico=&CodigoGrupoServico=&dataConnection=

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)

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 - novo operador de encerramento (Opcional)
  • tipo - código do tipo de OS (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 (Opcional)
  • CodigoContrato - código do contrato (Opcional)
  • CodigoServidor - código do servidor (Obrigatório)
  • CodigoPlanoAcesso - código do plano de acesso (Obrigatório)
  • CodigoTipoIP - parâmetro do tipo do IP (Obrigatório)
Tipo de IPParâmetro
Atribuição1
Dinâmico2
Requisito3
Pool MK4
IPV6 Pool5
  • Tecnologia -  parâmetro da tecnologia da conexão (Obrigatório)

Tecnologia

Parâmetro

Wireless

W
FTTHF
UTPU
  • 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


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


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 
  • lon= Longitude do endereço

Exemplo de saída:

Exemplo de uma saída ao chamar o Webservice WSMKNovaPessoa


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

PUT /pessoas

Parâmetros:

  • token - token de retorno da autenticação (Obrigatório)
  • id - código do cadastro do cliente (Obrigatório)
  • email - novo email do cliente (Opcional)
  • classificacao - nova classificação para o cliente (Opcional)
  • nascimento - data de nascimento (Opcional)
  • fone - novo número do celular (Opcional)
  • estadoId - novo estado (endereço geral) (Opcional)
  • estadoCobrancaId - novo estado (endereço de cobrança) (Opcional)
  • cidadeId - nova cidade (endereço geral) (Opcional)
  • cidadeCobrancaId - nova cidade (endereço de cobrança) (Opcional)
  • bairroId - novo bairro (endereço geral) (Opcional)
  • bairroCobrancaId - novo bairro (endereço de cobrança) (Opcional)
  • logradouroId - novo logradouro (endereço geral) (Opcional)
  • logradouroCobrancaId - novo logradouro (endereço de cobrança) (Opcional)
  • numero - novo logradouro (endereço geral) (Opcional)
  • numeroCobranca - novo logradouro (endereço de cobrança) (Opcional)
  • cep - novo CEP (endereço geral) (Opcional)
  • cepCobranca - novo CEP (endereço de cobrança) (Opcional)

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

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

Saída:

Na saída temos 3 blocos de retorno 

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

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

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

    • ValorTotalDesApresenta 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)


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

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

Saída:

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=tokenRetornoAutenticacao

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

Onde:

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

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

    • info - Informação sobre o atendimento

Atenção

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


Exemplo de saída:


ENCERRAR 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

PUT IP:PORTA/core-api/atendimentos?token=&id=

Onde:

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

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)

CRIAR NOVO PRÉ-CADASTRO E ABRIR LEAD DO CRM


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




  • No labels