Consultar Ordem de Serviço

Caro Cliente, a Simpress disponibiliza uma API para consulta de atendimentos técnicos vinculados ao número de série de seus equipamentos, independentemente da origem da solicitação — seja ela realizada diretamente pelo portal da Simpress ou por meio de integração com sistemas internos.

Essa funcionalidade permite que você acompanhe o andamento das Ordens de Serviço associadas ao número de série informado, visualizando o número da OS, seu status atual, e outras informações relevantes diretamente em seu sistema.

Com isso, você ganha visibilidade centralizada sobre os atendimentos em andamento, concluídos ou cancelados, facilitando o controle e a tomada de decisão em sua operação.Caso deseje realizar ações adicionais, como cancelamento ou reabertura de OS, essas funcionalidades também podem estar disponíveis conforme o escopo da API utilizada.

Endpoint:

GET https://apiexterno.simpress.com.br/camadadeservico/integracaoservicedesk/v1/OrdensDeServico/Contrato/{contrato}/{serie}/{chave}

Descrição:

Permite consultar as ordens de serviço vinculadas a um equipamento específico, utilizando o número de série como identificador principal.

Autenticação:

A API requer o uso de uma chave de acesso ({chave}) válida para autenticação. Essa chave deve ser fornecida pela Simpress.

Parâmetros de Caminho:

contrato

string – Obrigatório – Número do contrato associado ao cliente. Exemplo: 0000

serie

string – Obrigatório – Número de série do equipamento. Exemplo: ABC1234567

chave

string – Obrigatório – Chave de autenticação fornecida pela Simpress. Exemplo: CHAVEFAKE123456

Exemplo de Requisição:

GET https://apiexterno.simpress.com.br/camadadeservico/integracaoservicedesk/v1/OrdensDeServico/Contrato/0000/ABC1234567/CHAVEFAKE123456

Resposta:
A resposta será um objeto JSON contendo os dados das ordens de serviço relacionadas ao número de série informado.


{
"cdServico": "5023272",
"status": "Finalizada",
"dataAbertura": "15/02/2024 03:15:11",
"dataFechamento": "22/02/2024 14:05:09",
"tipo": "Instalação de Equipamento",
"SLAContabilizadoConclusao": "119",
"SLAConclusao": "3000",
"SLAPrimeiroAtendimento": "3000",
"SLAContabilizadoPrimeiroAtend": "0",
"observacoes": "Instalação de Equipamento"
}


Descrição dos Campos:

• cdServico: Código único identificador da ordem de serviço.
• status: Estado atual da OS (neste caso, "Finalizada").
• dataAbertura: Data e hora em que a OS foi criada.
• dataFechamento: Data e hora em que a OS foi encerrada.
• tipo: Tipo de serviço solicitado (ex: instalação, manutenção).
• SLAContabilizadoConclusao: Tempo real contabilizado até a conclusão.
• SLAConclusao: Tempo máximo permitido para conclusão da OS segundo o SLA.
• SLAPrimeiroAtendimento: Tempo máximo permitido para o primeiro atendimento.
• SLAContabilizadoPrimeiroAtend: Tempo real contabilizado até o primeiro atendimento.
• observacoes: Comentários ou informações adicionais sobre a OS.

Códigos de Resposta:

200

Consulta realizada com sucesso

401

Chave de autenticação inválida

404

Equipamento ou contrato não encontrado

500

Erro interno no servidor

Possiveis Status:

Suporte:
Em caso de dúvidas ou problemas com a integração, entre em contato com o suporte técnico da Simpress.

Portal de APIs - Simpress