Learn in this article what the default WebService APIs routes of OTRS & Znuny are. Often it is unclear what Routes / URLs and operations to use.
In the previous article Access Znuny & OTRS API via REST, we guide you thru the configuration steps of REST API in the role of the service provider. If you followed the steps your system is now accessible via new REST API routes and is providing data in response to REST API requests.
REST API routes
The default configuration of the REST API web service introduces new routes which are created in the branch:
http://{{znunyHostName}}/otrs/nph-genericinterface.pl/Webservice/{{webservice name}}
as we have chosen “Ticket REST API” use it HTML-encoded string in the form “Ticket%20REST%20API” in URL instead, so our base URL or REST API will look like this:
http://{{znunyHostName}}/otrs/nph-genericinterface.pl/Webservice/Ticket%20REST%20API/
The configured REST API is exposing the following web service routes to us under this root:
| Route | Function | Method | DataParser |
| …/Session | SessionCreate | POST | JSON |
| …/Session/:SessionID | SessionGet | GET | JSON |
| …/Ticket | TicketCreate | POST | JSON |
| …/Ticket/:TicketID | TicketGet | GET | JSON |
| …/TicketList | TicketGetList | GET | JSON |
| …/TicketHistory/:TicketID | TicketHistoryGet | GET | JSON |
| …/Ticket | TicketSearch | GET | JSON |
| …/Ticket/:TicketID | TicketUpdate | PATCH | JSON |
integratION with Znuny REST API?
You require a integration of another system/application to share data between Znuny and your system.
You struggle to get started, as the implementation of the API is not that straight forward as you thought?
You are not alone, we have many customers with the same issue!
Get started with a hand crafted set of REST Call in Postman and Bruno
Authentication
Every request has to be authenticated. The authentication of the HTTP request is done using one of two methods:
- UserLogin & Password
- Session Auth (recommended)
The details which authentication to use in your case, you can find in Authenticate to Znuny / OTRS REST API
REST API Request options for request body or query params
The OTRS/Znuny is open source as such the best documentation of all actual options can be found in the source code. The web service source code is located in the “Kernel/GenericInterface/Operation/” folder.
| Operation | Link to GitHub |
| Ticket Create | …/Ticket/TicketCreate.pm |
| Ticket Update | …/Ticket/TicketUpdate.pm |
| … |
Related articles
Access Znuny & OTRS API via REST
Authenticate to Znuny / OTRS REST API
Examples Calling REST API of Znuny & OTRS with cURL
You want to integrate with Znuny REST API?
You require a integration of another system/application to share data between Znuny and your system.
You struggle to get started, as the implementation of the API is not that straight forward as you thought?
You are not alone, we have many customers with the same issue!
After spending lots of time in supporting our customer, we have created the most common API accesses in Postman and Bruno.
So that your business analysts or developers can test the API and may define or integrate your needs.
Just for completeness, we offer also such development support and we can assign you the corresponding experts.
Do you require experts with real expertise since 2006 on Znuny and OTRS?
Do you require help on solving your issues?
We have experts who can help you on:
Integrating Issue trackers
like
- Jira
- Redmine
- Azure DevOps, / Team Foundation Server
- IBM Rational ClearQuest
- IBM Engineering Workflow Management / Rational Team Concert / Jazz
- Siemens Polarion
- Adobe Workfront / AtTask
- Trello
- GitHub
- GitLab
- Asana
- and many more
Integrating CRM systems
like
- Salesforce
- Microsoft Dynamics 365
- Oracle CRM
- SAP CRM
- Adobe Experience Cloud / Marketo Engage, Workfront
- HubSpot CRM
- Zoho CRM
- SugarCRM / SuiteCRM / Vtiger CRM & OSS
- Pipedrive
- Zendesk Sell
- and many more
Integrating ERP systems
like
- SAP S/4HANA
- Oracle ERP Cloud
- Microsoft Dynamics 365
- Finance & Operations
- Sage X3
- Compiere / ADempiere / iDempiere
- Apache OFBiz
- Openbravo
- Odoo
- ERPNext
- Dolibarr
- and many more
Beside of the above named solutions we can help you to integrate into more business and branch specific solutions:
Integrating artificial intelligence / AI
like
- AI Chatbots to aid your support agents
- integrate private data chatbots, with exclusive access to your data without sharing to OpenAI, Microsoft or any other AI companies
- create and integrate AI models based on your data to get a unique business model for your team
- and many more
Integrating accounting systems
like
- DATEV Rechnungswesen, DATEV Unternehmen Online, sevDesk, Lexware (DE)
- BMD Business Software, RZL, DIAMANT (AT)
- Abacus (CH)
- Forvis Mazars, Swiss21, Banana Accounting (CH)
- Cegid XRP Flex, Captivea, EBP (FR)
- QuickBooks, Freshbooks
- and many more
Integrating branch specific systems
like
- Sage Handwerk, TopKontor Smart-Handwerk,
STREIT Handwerkersoftware, CENDAS, OfficeOn,
openHandwerk, ToolTime, Plancraft, HERO,
Das Programm, Craftboxx, Taifun, M‑Soft, extragroup, PraKom - and many more