OTOBO / Znuny Guide

Português

English
Deutsch
Français
Español
Italiano
Polski
Nederlands

Português

English
Deutsch
Français
Español
Italiano
Polski
Nederlands

OTOBO / Znuny Web Services - REST API ​

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

INFO

Este artigo sobre Web Services tem uma grande sobreposição com o artigo REST API REST API.

Num mundo globalmente conectado, os sistemas de tickets precisam ser capazes de reagir automaticamente a pedidos de outros sistemas, bem como de enviar pedidos ou dados para serviços externos. OTOBO, o poderoso sistema de tickets de código aberto, enfrenta este desafio com a sua Interface Genérica. Permite aos administradores criar Web Services para várias tarefas sem conhecimento profundo de programação. OTOBO suporta a comunicação via protocolo REST e SOAP, permitindo a integração perfeita com:

  • Sistemas CRM
  • Sistemas de Gestão de Projetos
  • Sistemas de Gestão de Documentos
  • e muitas outras aplicações

Um Web Service funciona como uma ligação entre OTOBO e sistemas externos. As Operações e o Invoker definem a direção da comunicação, enquanto o Mapping e o Transport determinam como os dados são transferidos e interpretados. Com OTOBO, pode configurar Web Services para executar ações internamente, iniciar pedidos em sistemas remotos, gerir conversões de dados entre os sistemas e definir o protocolo de comunicação.

O acesso aos Web Services encontra-se no módulo Web Services do grupo Processos & Automação. Uma instalação nova de OTOBO não contém Web Services pré-configurados por defeito. A documentação seguinte ilustra como os Web Services podem ser criados, editados, eliminados, clonados, exportados e importados, bem como a utilização da ferramenta de depuração. Para tal, 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 seus processos de negócio com inúmeras ferramentas e sistemas externos. Ao gerar e utilizar estes Services, a eficiência é aumentada ao reduzir as intervenções manuais e encurtar os tempos de resposta aos pedidos dos clientes. Além disso, a versatilidade da interface genérica garante que OTOBO é quase ilimitadamente extensível, integrando-se assim perfeitamente nas paisagens de TI existentes.

Segurança e Configuração ​

Em relação à configuração e segurança dos Web Services, é importante notar que na exportação, todas as palavras-passe armazenadas são exportadas em texto simples. A guarda e o manuseamento de palavras-passe devem, portanto, ser tratados com especial cuidado.

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

Documentação das Conexões ​

Os Web Services oferecem, num ambiente operacional cada vez mais digitalizado, a possibilidade de ligar 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 antecipadamente. Abaixo, os fundamentos das definições para Web Services em OTOBO são explicados em detalhe para lhe fornecer um guia de ação mais abrangente.

Definições Gerais de Interfaces ​

  • Nome*

    • O nome identifica unicamente o Web Service dentro do OTOBO. É importante escolher um nome claro e descritivo que reflita a função ou o Parceiro com o qual se interage.

  • Descrição

    • Um comentário alargado que descreve detalhadamente o propósito e a funcionalidade do Web Service. Isto facilita a clareza e a manutenção.

  • Sistema Remoto

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

  • Limite de Depuração

    • Escolha o nível de detalhe da registo da comunicação. As definições variam de Debug (registo mais detalhado) a Error (apenas mensagens de erro).

  • Validade

    • Determina se o Web Service está ativado (válido) ou desativado (inválido, temporariamente inválido). Apenas 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, existem diferentes protocolos. A escolha do transporte de rede é fundamental:

  • Transporte de Rede

    • Escolha entre HTTP::REST e HTTP::SOAP. Estes 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 operações, para o Web Service. Pode escolher entre uma variedade de operações pré-definidas, como por exemplo Ticket::TicketCreate para criar tickets.

Criação de um Ticket via REST ​

Um exemplo prático ilustra o valor dos Web Services no OTOBO. Através do protocolo HTTP::REST, a operação Ticket::TicketCreate pode ser configurada. As rotas definidas permitem que sistemas externos criem Tickets no OTOBO utilizando pedidos HTTP POST. Isto realiza novas dimensões de automação e integração, o que pode aumentar significativamente a eficiência dos processos e a satisfação do cliente.

Web Services OTOBO AI Ticket Classification (ATC) ​

Para utilizar a Classificação de Tickets por IA (ATC) no OTOBO, tem de configurar as definições de Web Services em conformidade. A ATC necessita de acesso através da API REST para aceder aos dados do ticket e realizar a classificação. Classificação de Tickets OTOBO

Aviso de Segurança ​

Tenha em atenção que na exportação das definições de Web Services, as palavras-passe podem ser exportadas em texto simples. É, portanto, essencial manusear informações sensíveis com proteção e observar os regulamentos de segurança.

A utilização eficaz de Web Services em OTOBO permite às empresas tornar os seus fluxos de trabalho mais inteligentes e ágeis. Através da configuração precisa das definições de Web Services, é criada uma base sólida que permite integrar OTOBO perfeitamente no ecossistema digital de uma empresa. Definições e Operações de Web Services no OTOBO

A integração de sistemas externos com OTOBO através de Web Services é uma parte essencial para garantir uma gestão de tickets eficiente. Esta integração é possibilitada pela definição de várias operações que podem executar ações específicas no âmbito do ciclo de vida do ticket. Uma parte essencial desta integração é a compreensão dos atributos necessários para cada operação e a utilização do padrão XLST para a transferência de dados.

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

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

Esta documentação permite aos desenvolvedores realizar personalizações com precisão e garantir que todos os pedidos contêm as informações necessárias para serem processados com sucesso.

Utilização do Padrão XLST para Transferência de Dados ​

A transformação XLST é uma técnica poderosa para transferir dados recebidos de pedidos de Web Services para um formato processável pelo OTOBO. Ao criar, por exemplo, um campo dinâmico "RemoteTicketID" para Tickets, pode armazenar e processar eficientemente os dados recebidos:

xml

<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 pode transformar o valor do atributo de entrada incidentID num campo dinâmico de ticket chamado RemoteTicketID.

Definiçõ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. A escolha do transporte de rede é essencial para garantir uma conexão adequada com o sistema externo. Após a seleção do transporte, a configuração deve ser guardada e ajustada de acordo com os requisitos específicos.

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

Conclusão e Próximos Passos ​

Ao fornecer uma API de Web Services versátil e configurável, OTOBO abre um mundo de possibilidades para a integração e automação de processos de gestão de tickets. Ao fornecer especificações precisas e utilizar padrões como XLST para a manipulação de dados, OTOBO oferece aos seus utilizadores uma base flexível para a expansão dos seus sistemas de ticketing em conformidade com os seus requisitos de negócio específicos.

Quer seja como fornecedor ou solicitante, o processamento preciso das definições de Web Services garante uma comunicação perfeita e eficiente com sistemas e serviços externos.