Ir para o conteúdo principal

Integração de Abertura de Solicitações de Serviço - Envio.

Esta integração permite que outros sistemas (CRM, ERP, Sistemas Especialistas e etc) efetuem a abertura de Solicitações de Serviços na plataforma. Não é possível abrir Solicitações de Serviços com data retroativa.  

MÓDULO

Gestão Inteligente de Manutenção.

REQUEST HEADERS

Formato: JSON
Tecnologia: REST
Método: POST
Content-Type: application/json

HEADERS

unit:
key: 

Os dados de autenticação são fornecidos pela equipe de suporte SISMETRO.

ABERTURA POR ID PATRIMÔNIO NO SISMETRO

Está opção deverá ser utilizada para abrir SS na plataforma. Deve ser enviado um registro por vez.

URL: https://post.api.sismetro.com/SS/save/
Nomenclatura: CamelCase
Variáveis: Case Sensitive

{ "idErpEmpresa": "1", "idErpFilial": "1", "idErpSolicitante": "655", "idPatrimonio": 2, "objeto": "BOMBA DE PRESSAO", "categoria": 11, "gravidade": 1, "urgencia": 1, "tendencia": 1, "idOrigem": "21546", "solicitadoPor": "MARIA", "descricao": "EQUIPAMENTO VAZANDO OLEO", "tipo": 5, "atendimento": 20, "tecnicoDesignado":"1124", "dataChamado": "2019-09-04T16:00:04Z", "ssExterna": "87994", "evolucao": 4, "idErpCentroCusto": "5454", "servicosRealizar": "SUBSTITUIR O CONJUNTO DE REPAROS DA CAIXA", "observacoes": "RECOLHER AS PEÇAS",
"idProjeto": 15152132, "triagem": 1, "status": 1,
"projeto": {     "nome": "PROJETO 001",     "tipo": 1,     "idErp": "2001",     "idErpTipoProjeto": "3001",     "idErpFase": "4001",     "idErpSubFase": "5001",     "idErpAtividade": "2001",     "idErpSubAtividade": "3001",     "idErpTarefa": "1001" }, "pedidos": [     {         "idErp": "154",         "statusNegociacao": "AGUARDANDO LIBERACAO"     }   ], "horaPrevisao": [     {     "idOcupacao": "154",     "previsao": "60"     } ] }

Obs.: Não deve ser utilizado caracteres especiais nem nova linha no body.


DEFINIÇÃO DE VALORES

Atributo Tipo Caracteres Obrigatório

Permite 

Atualizar?

 Valor
idErpEmpresa Text 20 Condicional
 Não

ID da empresa no ERP.
Condicional:

  • Obrigatório: Quando o parâmetro "idPatrimonio" for igual a ID 2 (equipamento sem cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão obrigatórios;
  • Ignorado: Quando o parâmetro "idPatrimonio" for diferente de ID 2 (equipamento com cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão ignorados e a SS será registrada para a empresa, filial e solicitante configurados no cadastro do patrimônio no SISMETRO.
idErpFilial Text 20 Condicional

 Não

ID da filial no ERP.
Condicional:

  • Obrigatório: Quando o parâmetro "idPatrimonio" for igual a ID 2 (equipamento sem cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão obrigatórios;
  • Ignorado: Quando o parâmetro "idPatrimonio" for diferente de ID 2 (equipamento com cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão ignorados e a SS será registrada para a empresa, filial e solicitante configurados no cadastro do patrimônio no SISMETRO.
idErpSolicitante Text 20 Condicional

 Sim 

ID do solicitante no ERP.
Condicional:

  • Obrigatório: Quando o parâmetro "idPatrimonio" for igual a ID 2 (equipamento sem cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão obrigatórios;
  • Ignorado: Quando o parâmetro "idPatrimonio" for diferente de ID 2 (equipamento com cadastro no SISMETRO) os parâmetros idErpEmpresa, idErpFilial e idErpSolicitante serão ignorados e a SS será registrada para a empresa, filial e solicitante configurados no cadastro do patrimônio no SISMETRO.
idPatrimonio Integer 20 Obrigatório Sim

ID do patrimônio no SISMETRO. Para abrir uma SS para um equipamento sem cadastro envie o ID 2 e descreva no parâmetro "Objeto" os dados do patrimônio.
objeto Text 65 Condicional Sim Dados descritivos do equipamento sem cadastro (Exemplo: Tipo, marca, modelo, serial e etc). Campo obrigatório apenas quando idPatrimonio for ID 2. Parâmetro ignorado quando idPatrimonio maior que ID 2.
categoria Integer 2 Condicional Sim

ID da categoria da SS.

Parâmetro obrigatório quando idPatrimonio for igual ID 2. Parâmetro ignorado quando idPatrimonio maior que ID 2 (Quando definido o patrimônio a SS assumirá a categoria do cadastro). Solicitar a equipe de suporte as categorias de SS utilizadas pelo cliente.
gravidade Integer 1 Opcional Não

ID da gravidade da SS.


  1. Sem gravidade;
  2. Pouco grave;
  3. Grave;
  4. Muito grave;
  5. Extremamente grave.

Quando não informado a gravidade é coletada do cadastro do equipamento. Na ausência da informação no cadastro do equipamento sera atribuído ID 1.
urgencia Integer 1 Obrigatório Não

ID da gravidade da SS.


  1. Pode esperar;
  2. Pouco urgente;
  3. O mais rápido possível;
  4. É urgente;
  5. Necessita ação imediata.
tendencia Integer 1 Opcional Não

ID da tendência da SS.


  1. Não irá piorar;
  2. Irá piorar a longo prazo;
  3. Irá piorar em médio prazo;
  4. Irá piorar em pouco tempo ;
  5. Irá piorar em rapidamente.


idOrigem

 Text 20 Obrigatório Não ID único do documento, oportunidade ou ocorrência no sistema integrado (CRM, ERP entre outros) que disparou a abertura da SS. 

solicitadoPor

 Text 25 Opcional Sim Nome da pessoa que abriu a SS.
descricao Text 65 Obrigatório Sim Descrição ou título da SS.
tipo Integer - Obrigatório Sim

Tipo da SS (Exemplo: Preventiva, corretiva e etc). Solicitar a equipe de suporte os tipos de SS que o cliente utiliza.
atendimento Integer - Opcional Sim Tipo de atendimento (Exmeplo: Remoto, no cliente, telefone e etc). Solicitar a equipe de suporte os tipos de atendimento que o cliente utiliza.
tecnicoDesignado Integer - Opcional Sim ID do técnico designado da SS.
dataChamado Date time Formato ISO Opcional Sim Data do chamado do cliente (Formato ISO aaaa/mm/dd hh:mm:ss). Esta data é apenas orientativa, a SS será aberta com data e hora do envio da requisição. 
ssExterna Text 20 Opcional Sim Número  da OS externa (Exemplo: OS De papel, de outros sistemas e etc).
evolucao Integer - Obrigatório Sim

Tipo da SS (Exemplo: Preventiva, corretiva e etc). Solicitar a equipe de suporte os tipos de SS que o cliente utiliza.
servicosRealizar Text - Obrigatório Sim

Descrição completa dos serviços a realizar.
observacoes Text - Opcional Sim

Observações da SS. Este campo não é exibido para o solicitante nem no print da SS.
idErpCentroCusto Text - Opcional Sim

ID do centro de custo da SS no ERP. A atribuição do centro de custo na SS deverá ser realizada seguindo as regras abaixo. 


  • Quando o parâmetro idPatrimonio igual ID 2 deverá ser atribuído o centro de custo na SS na seguinte ordem:
     
    • Centro de custo enviado neste parâmetro;

    • Centro de custo do solicitante enviado no parâmetro idErpSolicitante.


  • Quando o parâmetro idPatrimonio for um cadastro válido deverá ser atribuído o centro de custo na SS na seguinte ordem:

    • Centro de custo enviado neste parâmetro;

    • Centro de custo do patrimônio na plataforma; 

    • Centro de custo da localização do patrimônio na plataforma; 

    • Centro de custo do solicitante do patrimônio na plataforma.

Caso nenhum centro de custo seja encontrado o campo ficará vazio.
projeto Objeto - -  - Dados do projeto vinculado a SS.
nome Text 20 Opcional Sim  Nome do projeto que a SS pertence.
tipo Text 20 Opcional Sim Tipo do projeto que a SS pertence.
idErp Text 20 Opcional Sim  ID do projeto no ERP.
idErpTipoProjeto Text 20 Opcional Sim  ID do tipo do projeto no ERP.
idErpFase Text 20 Opcional Sim  Fase do projeto no ERP.
idErpSubFase Text 20 Opcional Sim  Sub fase do projeto no ERP.
idErpAtividade Text 20 Opcional Sim  Atividade do projeto no ERP.
idErpSubAtividade Text 20 Opcional Sim  Sub atividade do projeto no ERP.
idErpTarefa Text 20 Opcional Sim  Tarefa do projeto no ERP.
triagem Integer 1 Opcional Sim

Abrir SS triada?

  1. Triada.
status Integer 1 Obrigatório Sim

Status da SS.

    1. Aberta;

    3. Excluída

    4. Cancelada;

    5. Não Aprovada.
idProjeto Integer - - Não 

ID do projeto no SISMETRO.

Função utilizada pelo CRM.
pedidos Set/Array - -
Listagem de pedidos que estão vinculados a SS.
      idErp Text 20 Opcional Sim  ID do pedido.
          statusNegociacao Text 20 Opcional Sim  Status de atendimento do pedido.
horaPrevisao Set/Array - Opcional
Array com previsão de horas por função
idOcupacao Integer - Opcional Não id da ocupação / função. (drawoccupation)
previsao Integer - Opcional Não Tempo de previsão em minutos


VALIDAÇÃO DE EXECUÇÃO DA INTEGRAÇÃO

Tipo da integração: 7
Vendor: 1
Status: 1

CHAVE DE UNICIDADE DE REGISTRO

Chave de unicidade na plataforma: unit + idErpEmpresa + idErpFilial + idOrigem
Comportamento do WebService: Cada requisição enviada gerará uma nova SS (não triada) na plataforma.

RETORNO

{    "valid":"valor",    "codigo":"valor",
   "url":"valor",    "messagem":"valor" }

Retorno Valor
valid TRUE ou FALSE.
codigo ID da SS. O sistema integrado deverá registrar essa informação.
url URL aberta da SS. O sistema integrado poderá registrar essa informação e exibir na tela para que o usuário tenha acesso ao print da SS sem necessitar estar logado na plataforma.
messagem Mensagem de confirmação ou de falta de informação e/ou falha.


MENSAGENS DE RETORNO

Status Mensagem
True SS aberta com sucesso.
True SS atualizada com sucesso.
False Empresa não informada ou inválida.
False Filial não informada ou inválida.
False Solicitante não informado ou inválido.
False Patrimônio não pertence ao solicitante.
False Patrimônio não informado ou inválido.
False Descrição da SS não informada ou inválida.
False Serviços a realizar não informado ou inválido.
False Tipo da SS não informado ou inválido.
False Centro de custo inválido.
False Status não informado ou inválido.

DÚVIDAS

Dúvidas Solução Direito
É possível editar o conteúdo de uma SS via integração? Não. Após a SS ser aberta todos os lançamentos devem ser realizados na plataforma. -
É possível alterar o status da SS? Sim. Para realizar esta operação deverá ser utilizado a integração de alteração de status de SS. Para mais informações clique aqui. -
Voltar ao topo