Welcome to the development documentation of the OpenTicket system. The goal of this documentation is to guide you through the process of setting up ticket sales for events in your own application using the OpenTicket system.
The documentation assumes that you have some basic knowledge regarding the development of web applications and the use of RESTful API (how to make RESTful API requests to other systems and how to deal with the responses). This means that the documentation is solely focused on interacting with the OpenTicket system through API and does not provide you with a step-by-step plan on how to set up your own application.
To make the documentation as accessible as possible, every section of the documentation starts with a high-level view of the subset of the OpenTicket system relevant for that section. These high-level views explain the most important resources used in the OpenTicket as well as possible.
To keep the documentation simple and accessible, there are some sections where details regarding the OpenTicket system are omitted. In general, this does not cause any issues, but there are some sections where the documentation assumes you are creating an event that only takes place on a single day. This does not mean that the OpenTicket system does not allow for events that span over multiple days; this is possible, but requires some more in-depth explanation which is outside the scope of this documentation. Currently, there are no plans to document this publicly. However, you can contact email@example.com for the full documentation.
In the left sidebar, you can see an overview of all the sections that are part of the documentation. The documentation starts with the process overview that you are reading right now. After this, you can move on to any of the other sections. The sections are written such that they can be followed in the given order. That way, you will be guided through the whole process in a natural way, which should result in a decent understanding of how to interact with the OpenTicket system. Every section can also be read on its own, as it will clearly refer to all the resources required to start with that section. Thus, if you get stuck at any point, you are able to move between sections without any issues.
The complete process of setting up ticket sales in your own application through the OpenTicket system will look somewhat like this:
- First, you will have to set up an authentication flow with the OpenTicket system. This flow is described in the authentication section, and elaborates upon how to acquire (and refresh) authentication tokens which are used to authenticate your requests to the system.
- After you have set up the authentication flow, you will be guided through the process of setting up events in the events section. This section will show you how to create a location for an event, create the event itself, and also assign date and time to this event.
- When you have created an event, you can start making tickets for this event. This is one of the more simple processes, and is described in the tickets section.
- Before you can sell the created tickets, you will have to create a shop. This process is described in the shops section and will show you how to set up a shop, add all of your tickets to the shop, and how to track internet traffic accessing the shop.
- Finally, when all other resources are created, the orders section will show you how to interact with the shop without using the interface provided by OpenTicket. This allows you to completely embed your ticket sales in your own application.