Panaudia

This REST API lets you create Spaces and their Tickets programatically.

As well as this guide we have some resources to help use this API:

API Keys

To access this API you must use an API Key created in the Panaudia web console.

To create an API Key navigate to the Organisation page in the web console and click on the API Keys tab. Then Click + to create a new Key for this Organisation.

You will be asked to give the key a name, choose its permissions and select which projects it can access. The name can be anything you like, it's just to help you to identify it. Choose read and write for a Key that can create new Shapes and Tickets, or just read for one that can only browse resources. You can select a number of existing Projects for the Key ot access or pick All Projects. If you choose All Projects the key will work for any new Projects created in the future as well as existing ones.

When you create an API Key you will see its two parts, an ID and a secret, something like this:

API Key ID        apikey_6905b764-b670-4184-bc80-b23c34f78bfe
API Key Secret    uphnj3nfrjw9j59y39d4zlrglq3q4i9zjz7l285y

Copy these both down right away and store them somewhere safe, we don't keep a copy of the secret so if you lose it you will have to delete its Key and create a new one. Store and use the Secret securely as anyone with access to it will be able to create resources on your account.

To use an API Key to access this API you should present it using Basic http auth with the ID as the username and the secret as the password in every call to the API.

You can check what permissions an API Key has:

GET /permissions



Projects

You can browse available Projects with:

GET /projects



And view a single Project with:

GET /projects/{project-id}



Spaces

Browsing Spaces

You can view all the Spaces for a Project with,

GET /projects/{project-id}/spaces



which can also be filtered by Space status,

GET /projects/{project-id}/spaces?status={status}



and you can view a single Space with.

GET /spaces/{space-id}



Creating Spaces

To create a new Space post to:

POST /projects/{project-id}/spaces



giving these details about the space you want in a json body:

name - A short human-readable name for the Space.
description - An optional longer description of the Space.
start_time - When you would like the Space to start.
duration_minutes - How long the Space goes on for.
region - Which of our available regions you would like to create the Space in. Pick the one nearest your users.
capacity - The maximum number of people the Space can hold. The options are 10, 25, 50, 100, 250 or 500
size - The size across the virtual Space in meters.
public_key - Optional, the public key Panaudia will use to validate Tickets

which should look something like this:

{
  "name": "Example Space One",
  "start_time": "2024-12-05T09:30:00Z",
  "region": "Netherlands",
  "capacity": 100,
  "size": 40,
  "description": "This is a very fine example Space.",
  "duration_minutes": 60,
  "public_key": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEA8gWcYikVd36AGFBDIgPRohe/qf3bzAyO2iTgz4148qQ=\n-----END PUBLIC KEY-----"
}

The value for public_key is optional and only necessary if you would like to create and sign Tickets for this Space yourself, rather than use this API to do it.

Tickets

You can read full details of Ticket configuration options on the Tickets page.

You can create tickets for a Space with:

POST /spaces/{space-id}/tickets



Post the json configuration for a ticket. A simple Ticket request could be just a name:

{ "name": "Paul" }

or something with extra configuration: