Getting Started

  1. Obtain your API token from the backend portal.
  2. Retrieve the Event UUID and SALT from the backend portal.
  3. Make a POST request to the event_types/list endpoint with the necessary parameters in the request body.
  4. Use the information from the response to create a ticket by making a POST request to the ticket/create endpoint.

Authentication

To make requests to the API, include your API token in the Authorization header as shown in the example request.

Base URL

The base URL for the KwiqPass Events API is https://api.kwiqpass.com.

Endpoint: List Event Types

Description

This endpoint provides a list of ticket types associated with a specific event.

Request

  • URL: https://api.kwiqpass.com/event_types/list
  • Method: POST
  • Headers:
    • Authorization: YOUR_TOKEN_KEY
    • Content-Type: application/json
  • Body: JSON
				
					{
  "e_uuid": "85d5487c51a",
  "salt": "your_salt_here"
}

Response

Upon a successful request, the API will respond with a JSON array containing ticket type information. Note that the image URLs for flyer, banner, and logo are not included in the response.

Example Response:

				
					[
    {
        "tType": "GENERAL",
        "tCost": "50.00",
        "typeId": "50",
        "e_uuid": "65d0e690cc51a",
        "eName": "Belize International Music and Food Festival",
        "eDate": "July 27th & 28th 2024",
        "eTime": "3:00PM",
        "flyer": null,
        "venue": "Saca Chispas Stadium",
        "district": "San Pedro",
        "banner": null,
        "logo": null
    },
    // Additional ticket types...
]

Constructing Image URLs

The image URLs for flyer, banner, and logo are not included in the API response from the event_types/list endpoint. Construct the URLs using the base URL for images:

  • Flyer: https://files.kwiqpass.com/assets/images/events/flyer_file_name.jpg
  • Banner: https://files.kwiqpass.com/assets/images/banner_file_name.jpg
  • Logo: https://files.kwiqpass.com/assets/images/logos/logo_file_name.jpg

Endpoint: Create Ticket

Description

This endpoint initiates the sale and creates tickets for the specified event and ticket type.

Request

  • URL: https://api.kwiqpass.com/ticket/create
  • Method: POST
  • Headers:
    • Authorization: YOUR_TOKEN_KEY
    • Content-Type: application/json
  • Body:
				
					{
  "salt": "88d8856sb5db",
  "e_uuid": "956290cc51a",
  "typeId": 50,
  "tCost": 50,
  "ref": "My Website Name",
  "email": "johndoe@gmail.com",
  "quantity": 1
}

Request Details

  • salt: A unique identifier provided by the backend portal.
  • e_uuid: Event UUID obtained from the backend portal.
  • typeId: Ticket type ID from the previous response.
  • tCost: Ticket cost from the previous response.
  • ref: Reference for the sale (e.g., “BTB Website”).
  • email: (Optional) Email of the purchaser for KwiqPass account integration.
  • quantity: Number of tickets to create.

Response

Upon a successful request, the API will respond with a JSON object containing information about the created ticket.

Example Response:

				
					{
    "RESULT": 0,
    "msg": "success",
    "QRID": "65d0f9649d73d",
    "timestamp": "2024-02-17 - 12:22:28"
}

  • QRID: This unique identifier, eg: “65d0f9649d73d,” is the Ticket ID. To facilitate event entry, you will need to convert this Ticket ID into a QR code. Attendees can then use their QR codes for seamless entry at the event.

  • timestamp: Indicates the date and time when the ticket was created (e.g., “2024-02-17 – 12:22:28”).

Important Note: Ensure that the QRID is properly encoded into a QR code format for efficient event management and entry.

Support and Contact

For any inquiries or issues, please contact our support team at hello@kwiqpass.com.