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.

URL

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

URL: https://api-upsim.herokuapp.com/SS/save/

BODY

Nomenclatura: CamelCase

Variáveis: Case Sensitive

{

"idErpEmpresa": "1",

"idErpFilial": "1",

"idErpSolicitante": "655",

"idPatrimonio": 2,

"objeto": "BOMBA DE PRESSAO",

"categoria": 11,

"gravidade": 1,

"urgencia": 1,

"idOrigem": "21546",

"descricao": "EQUIPAMENTO COM VAZANDO OLEO"

"tipoSs": 5,

"atendimento": 20,

"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",

"status": 1,

"pedidos":

[{

"idErp": "154",

"statusNegociacao": "AGUARDANDO LIBERACAO"

}]

}

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	~~String~~Text	20	Obrigatório	Não	ID da empresa no ERP.
idErpFilial	~~String~~Text	20	Obrigatório	Não	ID da filial no ERP.
idErpSolicitante	~~String~~Text	20	Obrigatório	Sim	ID do solicitante no ERP.
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. Quando este parâmetro for igual a ID 2 não deverá ser validado se o patrimônio pertence ao solicitante.
objeto	~~String~~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 Sim

ID da gravidade da SS.

Sem gravidade; Pouco grave; Grave; Muito grave; 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 Sim

ID da gravidade da SS.

Pode esperar; Pouco urgente; O mais rápido possível; É urgente; Necessita ação imediata. idOrigem ~~String~~Text 20 Opcional Não ID único do documento, oportunidade ou ocorrência no sistema ~~integrado(~~integrado (CRM, ERP entre outros) que disparou a abertura da SS. descricao ~~String~~Text 65 Obrigatório Sim Descrição ou título da SS. tipoSs 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. 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 ~~String~~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 ~~String~~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 ~~String~~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.

status Integer 1 Obrigatório Sim

Status da SS.

1. Aberta;

3. Excluída

4. Cancelada;

5. Não Aprovada.

pedidos Set/Array - - Listagem de pedidos que estão vinculados a SS. idErp ~~String~~Text 20 Opcional Sim ID do pedido. statusNegociacao ~~String~~Text 20 Opcional Sim Status de atendimento do pedido.

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