Caro Cliente, a Integração ServiceDesk permite a criação e acompanhamento das ordens de serviço de atendimento técnico de maneira eficaz e centralizada.
Por intermédio desta integração, você pode automatizar a criação de Ordens de Serviço na Simpress a partir de seu sistema interno para gestão de tickets, ganhando eficiência operacional. Além disso, este processo proporciona maior confiabilidade das informações devido aos mecanismos de autenticação e segurança no tráfego de seus dados.
Você também pode utilizar esta integração para acompanhar o andamento das Ordens de Serviço abertas conosco, visualizando o número e o tracking de status da OS diretamente no seu sistema.
Caso seja necessário cancelar uma Ordem de Serviço aberta conosco, também é possível automatizar este processo. Nossas APIs permitem que você mantenha o controle das Ordens de Serviço ao longo de todo seu ciclo de vida.
Ao longo desta documentação, você conhecerá todos os detalhes necessários para consumir nossas APIs e se conectar aos nossos sistemas.
Endereço usado como endereço raiz para todas as funcionalidades. Exemplo: "https://apiexterno-dev2.simpress.com.br/camadadeservico/integracaoservic..." .
Objetivo é consultar uma Ordem de Serviço utilizando como identificador o Número do Atendimento e o Número de Série. Caso informações inválidas sejam utilizadas, as mensagens de validação serão exibidas no retorno.
Endereço Base + /v1/ordensdeservico/{Atendimento}/{NumeroSerie}/{Chave}
Método: Get
Entrada | ||
Campo | Descrição | Obrigatório |
{Atendimento} | Número do atendimento que é informado após a abertura da Ordem de Serviço. | Sim |
{NumeroSerie} | Número de Série do equipamento. | Sim |
{Chave} | Sequência de caracteres, informado pela equipe Simpress Service Desk. | Sim |
Saída | ||
{ "NumeroSerie": "3575266XXZZ", "CodigoTipoDefeito": 6, "DescricaoTipoDefeito": "ATOLAMENTO – ENCRAVAMENTO", "CodigoSituacaoEquipamento": 1, "DescricaoSituacaoEquipamento": "EQUIPAMENTO INOPERANTE", "DadosResponsavel": { "Nome": "Marcos Ponte", "Email": "marcos@exemplo.com.br", "DDD": "11", "Telefone": "11111111", "Departamento": "Service Desk", "Observacao": null }, "DadosAdicionais": { "DadoAdicional1": null, "DadoAdicional2": null, "DadoAdicional3": null, "DadoAdicional4": null }, "Observacao": "Impressora não Imprime", "Contrato": 10542, "ItemContrato": 70, "NumeroOrdemServico": 3880182, "StatusOrdemServico": "Ativa", "NumeroAtendimento": 7954285, "NumeroInibicao": 0, "ServicoCliente": null, "EnderecoInstalacao": { "RazaoSocial": "XPTO LTDA", "CNPJ": "0143855542422", "Logradouro": "R Bela Vsita", "Numero": "120", "Complemento": "2º A", "Bairro": "Jd. Bela Vista", "Cidade": "São Paulo", "UF": "SP", "CEP": "08672115" }, "Historico": [ { "StatusDescricao": "Ativa", "DataOperacao": "2022-03-23T17:15:43.967", "Observacao": null, "Ocorrencia": null } ] } |
Objetivo é consultar uma Ordem de Serviço utilizando como identificador o Número da Ordem de Serviço e o Número de Série.
Caso informações inválidas sejam utilizadas, as mensagens de validação serão exibidas no retorno.
Endereço Base +
+ /v1/OrdensDeServico/{NumeroSerie}/{OrdemServico}/{Chave}
Método: Get
Entrada | ||
Campo | Descrição | Obrigatório |
{NumeroSerie} | Número de Série do equipamento. | Sim |
{OrdemServico} | Número da Ordem de Serviço que é informado após a abertura da mesma. | Sim |
{Chave} | Sequência de caracteres, informado pela equipe Simpress Service Desk. | Sim |
Saída | ||
{ "NumeroSerie": "3575266XXZZ", "CodigoTipoDefeito": 6, "DescricaoTipoDefeito": "ATOLAMENTO – ENCRAVAMENTO", "CodigoSituacaoEquipamento": 1, "DescricaoSituacaoEquipamento": "EQUIPAMENTO INOPERANTE", "DadosResponsavel": { "Nome": "Marcos Ponte", "Email": "marcos@exemplo.com.br", "DDD": "11", "Telefone": "11111111", "Departamento": "Service Desk", "Observacao": null }, "DadosAdicionais": { "DadoAdicional1": null, "DadoAdicional2": null, "DadoAdicional3": null, "DadoAdicional4": null }, "Observacao": "Impressora não Imprime", "Contrato": 10542, "ItemContrato": 70, "NumeroOrdemServico": 3880182, "StatusOrdemServico": "Ativa", "NumeroAtendimento": 7954285, "NumeroInibicao": 0, "ServicoCliente": null, "EnderecoInstalacao": { "RazaoSocial": "XPTO LTDA", "CNPJ": "0143855542422", "Logradouro": "R Bela Vsita", "Numero": "120", "Complemento": "2º A", "Bairro": "Jd. Bela Vista", "Cidade": "São Paulo", "UF": "SP", "CEP": "08672115" }, "Historico": [ { "StatusDescricao": "Ativa", "DataOperacao": "2022-03-23T17:15:43.967", "Observacao": null, "Ocorrencia": null } ] } |
Objetivo é consultar uma Ordem de Serviço utilizando como identificador o código do cliente.
Caso informações inválidas sejam utilizadas, as mensagens de validação serão exibidas no retorno.
Endereço Base +
/v1/OrdensDeServico/{chaveAutenticacao}/{ServicoCliente}?numeroserie=xA1000XX&apelido=maq222323.
Método: Get
Entrada | ||
Campo | Descrição | Obrigatório |
{ChaveAutenticacao} | Sequência de caracteres, informado pela equipe Simpress Service Desk. | Sim |
{ServicoCliente} | Número da Ordem do sistema de origem (cliente). | Sim |
{Numeroserie ou Apelido} | Número de série ou Alias (apelido) do equipamento. | Sim |
Saída | ||
{ "NumeroSerie": "3575266XXZZ", "CodigoTipoDefeito": 6, "DescricaoTipoDefeito": "ATOLAMENTO – ENCRAVAMENTO", "CodigoSituacaoEquipamento": 1, "DescricaoSituacaoEquipamento": "EQUIPAMENTO INOPERANTE", "DadosResponsavel": { "Nome": "Marcos Ponte", "Email": "marcos@exemplo.com.br", "DDD": "11", "Telefone": "11111111", "Departamento": "Service Desk", "Observacao": null }, "DadosAdicionais": { "DadoAdicional1": null, "DadoAdicional2": null, "DadoAdicional3": null, "DadoAdicional4": null }, "Observacao": "Impressora não Imprime", "Contrato": 10542, "ItemContrato": 70, "NumeroOrdemServico": 3880182, "StatusOrdemServico": "Ativa", "NumeroAtendimento": 7954285, "NumeroInibicao": 0, "ServicoCliente": null, "EnderecoInstalacao": { "RazaoSocial": "XPTO LTDA", "CNPJ": "0143855542422", "Logradouro": "R Bela Vsita", "Numero": "120", "Complemento": "2º A", "Bairro": "Jd. Bela Vista", "Cidade": "São Paulo", "UF": "SP", "CEP": "08672115" }, "Historico": [ { "StatusDescricao": "Ativa", "DataOperacao": "2022-03-23T17:15:43.967", "Observacao": null, "Ocorrencia": null } ] } |
Endereço Base + /v1/OrdensDeServico/{CodigoServico}/{Chave}
Método: Get
Objetivo é cancelar uma Ordem de Serviço utilizando como identificador o Número da Ordem de Serviço e a chave de autenticação.
Caso informações inválidas sejam utilizadas, as mensagens de validação serão exibidas no retorno.
Entrada | ||
Campo | Descrição | Obrigatório |
{CodigoServico} | Número da Ordem de Serviço | Sim |
{Chave} | Sequência de caracteres, informado pela equipe Simpress Service Desk. | Sim |
Saída | ||
Objeto Json |
Método para retornar quais os tipos de defeitos possíveis para o equipamento selecionado, necessário enviar o número de série.
Endereço Base + /v1/Equipamentos/Diagnosticos/{numeroSerie}
Método: Get
Entrada | ||
Campo | Descrição | Obrigatório |
{numeroSerie} | Número de série do equipamento | Sim |
Saída | ||
Objeto formatado com tipos de Defeitos. |
Foi disponibilizado um método POST para solicitar a abertura de uma Ordem de Serviço. Segue o detalhe:
Endereço Base + /v1/OrdensDeServico
Método: Post
Objetivo é solicitar a abertura de uma Ordem de Serviço utilizando diversos dados que serão informados.
Caso informações inválidas sejam utilizadas, as mensagens de validação serão exibidas no retorno.
Entrada | |||
Campo | Descrição | Obrigatório | Tamanho |
NumeroSerie ou Alias {Apelido} | Número de série ou Apelido do equipamento para o qual solicitara o serviço. | Sim | 100 |
CodigoTipoDefeito | Tipo de Defeito que ocorreu no equipamento, deverá escolher um código de defeito de acordo com o retorno do serviço no Item "Tipos de Defeitos". | Sim | n/a |
CodigoServicoCliente | Código de serviço do sistema de origem. | Não | 100 |
CodigoSituacaoEquipamento | Código da situação do equipamento, veja a lista de possíveis códigos. Permitindo apenas um código. | Sim | n/a |
ChaveAutenticacao | Formado por uma sequência de caracteres única que é informada pela equipe de Service Desk da Simpress. | Sim | n/a |
Observacao | Campo texto livre para observações da abertura da Ordem Serviço | Não | 500 |
Nome | Nome do responsável pela solicitação de abertura. | Sim | 100 |
E-mail do responsável pela solicitação. | Sim | 100 | |
DDD | Código de área do telefone do responsável pela solicitação. Informar apenas números. | Sim | 2 |
Telefone | Número do telefone do responsável pela solicitação. Informar apenas números. | Sim | 9 |
Departamento | Nome do departamento do responsável pela solicitação. | Sim | 100 |
DadosAdicional1 | Informação para uso de referência pelo cliente. Esta informação estará presente nos retornos. | Não | 100 |
DadosAdicional2 | Informação para uso de referência pelo cliente. Esta informação estará presente nos retornos. | Não | 100 |
DadosAdicional3 | Informação para uso de referência pelo cliente. Esta informação estará presente nos retornos. | Não | 100 |
DadosAdicional4 | Informação para uso de referência pelo cliente. Esta informação estará presente nos retornos. | Não | 100 |
Saída | |||
{ "NumeroSerie":"XXXX122332", "CodigoTipoDefeito":494, "DescricaoTipoDefeito":"CÓDIGO DE ERRO NO EQUIPAM", "CodigoSituacaoEquipamento":1, "DescricaoSituacaoEquipamento":"EQUIPAMENTO INOPERANTE", "DadosResponsavel":{ "Nome":"[nome do responsável]", "Email":"[e-mail do responsável]", "DDD":"11", "Telefone":"2127-6484", "Departamento":"Dep.01", "Observacao":"Falar com responsável" }, "DadosAdicionais":{ "DadoAdicional1":null, "DadoAdicional2":null, "DadoAdicional3":null, "DadoAdicional4":null }, "Observacao":"descrição do chamado", "Contrato":1111, "ItemContrato":121, "NumeroOrdemServico":3742166, "StatusOrdemServico":"Ativa", "NumeroAtendimento":7678301, "NumeroInibicao":0, "ServicoCliente":"SERV.0234", "EnderecoInstalacao":{ "RazaoSocial":"COMPANHIA XPTO", "CNPJ":"28150000234444", "Logradouro":"RUA BELA VISTA", "Numero":"100", "Complemento":"ADMISTRATIVO", "Bairro":"CENTRO", "Cidade":"Marechal", "UF":"SP", "CEP":"07272-000" }, "Historico":[ { "StatusDescricao":"Ativa", "DataOperacao":"2021-12-08T16:10:50.2007116-03:00", "Observacao":null, "Ocorrencia":null } ] } |
A integração permite que seja configurado um meio de comunicação para receber informações sobre atualizações de status das ordens de serviços que foram abertas.
As atualizações para os parceiros são feitas via Get “consulta por atendimento” e “consulta por número de série” passando a ordem que foi gerada na integração conforme nos itens acima.
O cliente executa as ordens e recebe o retorno no mesmo processo tendo ostatus do chamado fazendo as atualizações nos repositórios necessários.
Tipos de Defeitos | |
Código | Descrição |
6 | Atolamento - Encravamento / Não Reconhece Papel |
22 | Cópia / Impressão cortada / Falhada / Riscada |
23 | Cópia / Impressão Clara / Ma |
27 | Não Inicializada / Não Liga |
38 | Auditoria do parque |
63 | Kit de Manutenção |
94 | Peça quebrada /Solta |
96 | Unidade Fotocondutora |
100 | Vazamento de toner |
101 | Auditoria de contador |
102 | Indica falta de toner |
148 | Auditoria de consumo |
259 | Ruído excessivo |
262 | Configuração de Driver de Impressão |
494 | Código de erro no Equipamento |
540 | Unidade de revelação |
551 | Atualizar firmaware (FSA) |
553 | Captura / Digitalização - Problema |
554 | Cópia / Impressão Escuras |
568 | Acessório com falha |
569 | Não fixa toner no papel |
570 | Aquecimento excessivo |
571 | Encravamento / Não reconhece papel |
572 | Mensagem de substituição reservatório de toner usado |
573 | Configuração de função de cópia |
574 | Configuração de scanner |
575 | Configuração de fax |
576 | Dúvidas contador equipamento |
577 | Dúvidas liberação crachá / senha |
578 | Dúvidas / Configuração bilhetagem |
579 | Erro liberação crachá / senha |
580 | Dúvidas de especificações de equipamento |
581 | Não digitaliza / Envia fax |
587 | Garantia B2C |
590 | CPMI - Corretivo |
592 | Nova Unidade de imagem |
593 | CPMI - Preventivo |
Situação do Equipamento | |
Código | Descrição |
1 | Equipamento inoperante |
2 | Impressão inoperante |
3 | Copiadora inoperante |
4 | Equipamento normal |
5 | Funcionamento precário |
6 | Acessório inoperante |