API TicketGo Add-On Detailed Documentation

Introduction

The API Integration Add-On in TicketGo is built to allow external systems to interact directly with core ticket functionalities. This documentation explains how to use each API endpoint effectively, from logging in and fetching ticket form data to submitting tickets, searching existing ones, and sending replies. Every API call requires proper authentication to ensure secure access. This guide will walk you through the structure, usage, and purpose of each API involved so that you can integrate TicketGo’s features smoothly into your system or platform.

How to Install the API Add-On?

Follow these steps for Installation: Setup API

How to Use the API Add-On?

• After purchasing the API Add-On, go to the sidebar and find out API Add-On under it.
• Here first of all you will see the introduction page, where you can understand the complete overview of the API settings.
• After the Introduction, comes the page for authentication from where you can get the API of post login and post logout.
• Admins and agents can log in to the system using the API. When an admin logs in, they get a unique token. Agents also get their own token after logging in. This token is important because it allows them to access other API features securely.
• Similarly, logout can be done through the API, which will invalidate the token and stop access until the user logs in again.

• After the authentication page, comes the ticket page. Here you can get ticket creation request data, post ticket store, post ticket search data, post ticket reply, and post ticket auth reply.
• To create a new ticket using the API, you first get the data of all custom fields available for ticket creation. This means you can see all the special fields like priority or category that are set up in your ticket system. Using this information, you can fill in the ticket details correctly when creating it through the API.
• Admins can see ticket data and conversations in real-time if Pusher settings are configured. Pusher is a service that updates the ticket page automatically without needing a manual refresh. If Pusher is not set up, admins will need to refresh the page to see new messages or changes.

• You can search for tickets by entering the ticket number and email. This makes it easier to find specific tickets quickly without going through the whole ticket list manually.
• Admins and agents who are assigned to a ticket can view and reply to live chat conversations with customers through the API. This live chat feature shows customer messages and replies as they happen, helping to solve issues faster.
• To access live chat data or any other sensitive ticket information, authentication is required. Only admins and agents who are logged in to the platform can use the API for these actions. This ensures that ticket data is safe and only available to authorized users.