OTOBO / Znuny Web Services - REST API

Introdução à Integração de Interfaces Externas

INFO

Este artigo de Web Service tem uma grande sobreposição com o artigo REST API REST API.

Em um mundo globalmente conectado, os sistemas de tickets precisam ser capazes de responder automaticamente a solicitações de outros sistemas e enviar solicitações ou dados para serviços externos. OTOBO, o poderoso sistema de tickets de código aberto, atende a esse desafio com sua Interface Genérica. Isso permite que os administradores criem web services para várias tarefas sem necessidade de conhecimento profundo de programação. OTOBO suporta a comunicação via protocolos REST e SOAP, permitindo a integração transparente com:

• Sistemas de Gerenciamento de Relacionamentos (CRM)
• Sistemas de Gerenciamento de Projetos
• Sistemas de Gerenciamento de Documentos
• e muitas outras aplicações

Um web service atua como um elo entre OTOBO e sistemas externos. Aqui, Operações e Invoker definem a direção da comunicação, enquanto Mapping e Transporte determinam como os dados são transferidos e interpretados. Com OTOBO, você pode configurar web services para executar ações internas, iniciar solicitações em sistemas remotos, gerenciar conversões de dados entre os sistemas e especificar o protocolo de comunicação.

O acesso aos Web Services está localizado no módulo Web Services do grupo Processos & Automação. Uma instalação fresca de OTOBO não contém web services pré-configurados por padrão. A seguir, a documentação ilustra como os web services podem ser criados, editados, excluídos, clonados, exportados e importados, bem como o uso da ferramenta de depuração. Para isso, consulte os passos detalhados na documentação oficial de administração do OTOBO.

Implementação das Interfaces

A implementação de Web Services em OTOBO permite uma integração flexível e dinâmica dos processos de negócios com inúmeras ferramentas e sistemas externos. Através da geração e utilização desses serviços, a eficiência é aumentada, reduzindo intervenções manuais e diminuindo os tempos de resposta às solicitações dos clientes. Além disso, a versatilidade da interface genérica garante que OTOBO seja praticamente ilimitado em termos de expansão e, portanto, se encaixa perfeitamente em paisagens de TI existentes.

Segurança e Configuração

Em relação à configuração e segurança dos web services, é importante notar que, ao exportar, todas as senhas armazenadas são exportadas em texto puro. Portanto, o armazenamento e o manuseio de senhas devem ser tratados com especial cuidado.

Para obter informações detalhadas sobre a configuração interna do sistema, como as opções de configuração de cache e módulos de frontend, recomendamos consultar o documento otobo-system-configuration.txt. Essa fonte oferece uma visão geral abrangente de todas as opções de configuração.

Documentação das Conexões

Os web services oferecem, em um ambiente de operação cada vez mais digitalizado, a possibilidade de conectar OTOBO a outros sistemas e serviços. Garantir uma comunicação eficiente e segura significa, portanto, configurar as definições de web services com precisão. A seguir, são explicadas em detalhes as bases das configurações para web services em OTOBO, para fornecer um guia de ação abrangente.

Configurações Gerais de Interface

• Nome*

  • O nome identifica o web service de forma única dentro do OTOBO. É importante escolher um nome claro e descritivo que reflita a função ou o parceiro com o qual interage.

• Descrição

  • Um comentário expandido que detalha o propósito e a funcionalidade do web service. Isso facilita a visibilidade e a manutenção.

• Sistema Remoto

  • Permite definir o nome do sistema externo com o qual o OTOBO interage.

• Limite de Depuração

  • Escolha como a logging da comunicação deve ser detalhada. As configurações variam de Depuração (logging mais detalhado) a Erro (somente mensagens de erro).

• Validade

  • Determina se o web service está ativado (válido) ou desativado (inválido, temporariamente inválido). Somente web services válidos são executados pelo OTOBO.

Transporte de Rede - SOAP ou REST

Para a implementação da integração com outros sistemas, diferentes protocolos estão disponíveis. Aqui, a escolha do transporte de rede é fundamental:

• Transporte de Rede

  • Escolha entre HTTP::REST e HTTP::SOAP. Esses protocolos definem como a transferência de dados ocorre entre o sistema de tickets OTOBO e o sistema conectado.

• Adicionar Operação

  • Permite definir ações específicas, chamadas de operações, para o web service. Aqui, você pode escolher entre uma variedade de operações pré-definidas, como Ticket::TicketCreate para criar tickets.

Criação de um Ticket via REST

Um exemplo prático ilustra o valor dos web services no OTOBO. Via protocolo HTTP::REST, é possível configurar a operação Ticket::TicketCreate. As rotas definidas permitem que sistemas externos criem tickets no OTOBO usando requisições HTTP-POST. Isso realiza novas dimensões de automação e integração, aumentando significativamente a eficiência dos processos e a satisfação do cliente.

Web Services OTOBO para Classificação de Tickets de IA (ATC)

Para usar a classificação de tickets de IA (ATC) no OTOBO, você precisa configurar as definições de web services adequadamente. A ATC requer acesso via REST API para acessar os dados do ticket e realizar a classificação. Classificação de Tickets OTOBO com IA

Aviso de Segurança

Lembre-se de que, ao exportar configurações de web services, as senhas podem ser exportadas em texto puro. É essencial tratar informações sensíveis com proteção e seguir as determinações de segurança.

A utilização eficaz de web services em OTOBO permite que as empresas projetem seus fluxos de trabalho de forma mais inteligente e ágil. Configurando as definições de web services com precisão, uma base sólida é criada para integrar OTOBO de forma transparente no ecossistema digital de uma empresa. Configurações e Operações de Web Services em OTOBO

A integração de sistemas externos com OTOBO via web services é uma parte essencial para garantir um gerenciamento de tickets eficiente. Essa integração é possibilitada pela definição de várias operações que podem executar ações específicas no ciclo de vida do ticket. Uma parte crucial dessa integração é entender os atributos necessários para cada operação, bem como o uso do padrão XLST para a transferência de dados.

Atributos Necessários para as Operações de Interface

Para as operações de ticket básicas em OTOBO, atributos específicos são necessários. Aqui estão links para recursos oficiais que descrevem em detalhes os atributos necessários para criar, recuperar, atualizar, buscar e obter a história de tickets:

• TicketCreate : Especificação do TicketCreate
  • TicketGet : Especificação do TicketGet
  • TicketUpdate : Especificação do TicketUpdate
  • TicketSearch : Especificação do TicketSearch
  • TicketHistoryGet : Especificação do TicketHistoryGet

Essa documentação permite que os desenvolvedores façam ajustes com precisão e garantam que todas as solicitações contenham as informações necessárias para serem processadas com sucesso.

Uso do Padrão XLST para a Transferência de Dados

A transformação XLST é uma técnica poderosa para transferir dados de requisições de web services para uma forma processável pelo OTOBO. Criando, por exemplo, um campo dinâmico "RemoteTicketID" para tickets, você pode armazenar e processar dados de entrada de forma eficiente:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:template match="/">
        <Ticket>
            <DynamicField>
                <Name>RemoteTicketID</Name>
                <Value>
                    <xsl:value-of select="incidentID"/>
                </Value>
            </DynamicField>
        </Ticket>
    </xsl:template>
</xsl:stylesheet>

Este exemplo mostra como transformar o valor do atributo de entrada incidentID em um campo dinâmico de ticket chamado RemoteTicketID.

Configurações de Web Services: Solicitante (Requester)

Para a implementação de procedimentos de web services como solicitante, OTOBO oferece a escolha entre os protocolos HTTP::REST e HTTP::SOAP. Aqui, a escolha do transporte de rede é elementar para garantir uma conexão adequada com o sistema externo. Após a seleção do transporte, a configuração deve ser salva e adaptada de acordo com as necessidades específicas.

A criação de um módulo de tratamento de erros também é um passo importante para garantir uma comunicação robusta. OTOBO permite implementar e configurar módulos específicos para isso.

Conclusão e Próximos Passos

Ao fornecer uma API de web services configurável para OTOBO, abre-se um mundo de possibilidades para a integração e automação de processos de gerenciamento de tickets. Oferecendo especificações precisas e utilizando padrões como XLST para a manipulação de dados, OTOBO fornece aos usuários uma base flexível para expandir seus sistemas de tickets de acordo com as necessidades específicas de negócios.

Seja como provedor ou solicitante, o processamento preciso das configurações de web services garante uma comunicação transparente e eficiente com sistemas e serviços externos.