Znuny Web Services - REST API

Znuny Web Services - REST API

Introduction to external interface integration

::: info This Web Service article has a significant overlap with the article REST API REST API. ::: In a globally connected digital environment, ticket systems must be able to react automatically to requests from other systems while simultaneously sending data or requests to external services. Znuny, the powerful open-source ticket system, addresses this requirement with its Generic Interface. It allows administrators to configure web services for a wide variety of tasks, even without extensive programming knowledge. Znuny supports communication via REST and SOAP protocols and enables seamless integration with:

• CRM systems
• Project management tools
• Document management systems
• and many other applications A web service acts as a bridge between Znuny and external systems. In this process, Operations and Invokers define the direction of communication, while Mapping and Transport determine how data is transmitted and interpreted. With Znuny, you can configure web services to execute internal actions, initiate requests on remote systems, manage data conversions between systems, and define the communication protocol. Access to the Web Services is located in the Web Services module within the Processes & Automation group. A fresh installation of Znuny does not contain any pre-configured web services by default. The following documentation illustrates how web services can be created, edited, deleted, cloned, exported, and imported, as well as the use of the debugger tool.

Implementation of interfaces

The implementation of web services in Znuny enables a flexible and dynamic integration of your business processes with numerous external tools and systems. By creating and using these services, efficiency is increased by reducing manual intervention and shortening response times to customer inquiries. Furthermore, the versatility of the Generic Interface ensures that Znuny is almost infinitely extensible and thus fits perfectly into existing IT landscapes.

Security and configuration

When configuring and securing web services, it should be noted that all saved passwords are exported in plain text during an export. The storage and handling of passwords should therefore be treated with special care. For detailed information on system-internal configuration, such as the configuration options for Cache and Frontend modules, we recommend consulting the official Znuny system configuration documentation.

Documentation of connections

In an increasingly digitized operating environment, web services offer the possibility to link Znuny with other systems and services. Ensuring efficient and secure communication therefore means configuring web service settings precisely in advance. In the following, the basics of the settings for web services in Znuny are explained in more detail to provide you with a comprehensive guide.

General interface settings

• Name*
  • The name uniquely identifies the web service within Znuny. It is important to choose a clear and descriptive name that reflects the function or the partner being interacted with.
• Description
  • An extended comment that details the purpose and functionality of the web service. This improves clarity and maintainability.
• Remote system
  • Allows you to specify the name of the external system with which Znuny interacts.
• Debug threshold
  • Choose how detailed the logging of the communication should be. The settings range from Debug (most detailed logging) to Error (only error messages).
• Validity
  • Determines whether the web service is activated (valid) or deactivated (invalid, temporarily invalid). Only valid web services are executed by Znuny.

Network transport - SOAP or REST

Different protocols are available for implementing integration with other systems. The choice of network transport is fundamental here:

• Network transport
  • Choose between HTTP::REST and HTTP::SOAP. These protocols define how data transmission occurs between the Znuny ticket system and the connected system.
• Add operation
  • Allows you to define specific actions, so-called operations, for the web service. You can choose from a variety of predefined operations, such as Ticket::TicketCreate for creating tickets.

Creating a ticket via REST

A practical example illustrates the value of web services in Znuny. The Ticket::TicketCreate operation can be set up via the HTTP::REST protocol. The defined routes allow external systems to create tickets in Znuny using HTTP-POST requests. This realizes new dimensions of automation and integration, which can significantly increase process efficiency and customer satisfaction.

Security note

Please note that passwords can be exported in plain text when exporting web service settings. It is therefore essential to handle sensitive information in a protected manner and to observe security regulations. The effective use of web services in Znuny allows companies to make their workflows more intelligent and agile. Through the precise configuration of web service settings, a solid foundation is created that allows Znuny to be seamlessly integrated into a company’s digital ecosystem.

Web service settings and operations in Znuny

The integration of external systems with Znuny via web services is an essential component for ensuring efficient ticket management. This integration is made possible by defining various operations that can execute specific actions within the ticket lifecycle. A key part of this integration is understanding the necessary attributes for each operation as well as using standards for data transmission.

Required attributes for interface operations

Specific attributes are required for the basic ticket operations in Znuny. The most important operations include:

• TicketCreate: Creates a new ticket with an associated article
• TicketGet: Retrieves detailed information about one or more tickets
• TicketUpdate: Updates existing ticket data
• TicketSearch: Searches for tickets based on defined criteria
• TicketHistoryGet: Retrieves the history of a ticket These operations allow developers to perform adjustments precisely and ensure that all requests contain the necessary information to be processed successfully.

Using XSLT for data transmission

XSLT transformation is a powerful technique for converting incoming data from web service requests into a form that Znuny can process. By, for example, creating a dynamic field “RemoteTicketID” for tickets, you can efficiently save and further process incoming data: Operations This example shows how you can transform the value of the incoming attribute incidentID into a ticket dynamic field named RemoteTicketID.

Web service settings: Requester

For the implementation of web service procedures as a requester, Znuny offers the choice between the protocols HTTP::REST and HTTP::SOAP. The selection of the network transport is elementary here to ensure a proper connection with the external system. After selecting the transport, the configuration must be saved and adjusted according to specific requirements. Setting up an error handling module is also an important step to guarantee robust communication. Znuny allows specific modules to be implemented and configured for this purpose.

Summary and next steps

By providing a versatile and configurable API for web services, Znuny opens up a world of possibilities for the integration and automation of ticket management processes. By providing precise specifications and using standards like XSLT for data manipulation, Znuny offers its users a flexible basis for expanding their ticketing systems in line with their specific business requirements. Whether as a provider or requester, the precise handling of web service settings ensures seamless and efficient communication with external systems and services.

Best Practices

• Secure authentication: Always use HTTPS and API keys for production environments
• Implement error handling: Set up dedicated error handlers for critical operations
• Enable logging: Use debug logging during development and disable it in production
• Versioning: Document changes to web service configurations for better traceability
• Testing: Thoroughly test all operations in a test environment before deploying them to production With careful configuration of Znuny Web Services, you create the foundation for successful integration into your IT landscape and benefit from automated, efficient business processes.