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

Open

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:

Exemplo de saída:

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

Open

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:

Open

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:

Open

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:

Open

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:

Open

Parâmetros:

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

Exemplo de saída:

Open

🆕 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:

  Open

  

  
  
  

ALTERAR 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

• • 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:

  Open

  
  Open

  

AUTO-DESBLOQUEIO

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

Open

VERIFICAR DISPONIBILIDADE DE PORTAS PRÓXIMAS (VIABILIDADE)

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:

Open

CONSULTAR NOTIFICAÇÃO DE PARADA

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:

Open

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

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:

Open

CONSULTAR OS ABERTAS PARA A NOTIFICAÇÃO DE PARADA

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:

Open

CONSULTAR ATENDIMENTOS ABERTOS PARA A NOTIFICAÇÃO DE PARADA

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:

Open

CRIAR CONEXÃO

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)

Open

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

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

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

Exemplo de saída:

CRIAR CADASTRO DE CLIENTE (NODE)

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:

Open

CRIAR CADASTRO DE CLIENTE

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:

• 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