Skip to content

Getting started

The venue creates the website key in Kisum Venues:

  1. Go to Settings > Website booking.
  2. Select New website key.
  3. Enter a name, list the websites allowed to use the key (one per line, for example thestage.com and www.thestage.com), choose All spaces or Selected spaces only, and select the date hold period.
  4. Select Create key and copy the key. It starts with kvw_.

The key is shown only once. If it is lost, the venue disables it and creates a new one.

The website key identifies the venue. It is not a password: it is visible in your website’s requests, and it only works from the websites listed on it.

All spaces lets the key use every published space of the venue. Selected spaces only limits the key to the spaces the venue ticks: the API then returns only those spaces, and every other space is refused with 404. For one booking page per space, ask the venue for one key per space.

Replace kvw_yourKey with the website key:

Terminal window
curl https://api.kisum.io/venues/public/v1/sites/kvw_yourKey/venue

A successful response looks like this:

{
"success": true,
"message": "ok",
"data": {
"name": "The Stage",
"city": "Denpasar",
"country": "Indonesia",
"currency": "IDR",
"timezone": "Asia/Makassar",
"description": "A live music venue and nightclub in Seminyak.",
"photos": [
"https://images.example.com/the-stage/cover.jpg",
"https://images.example.com/the-stage/main-hall.jpg"
],
"restrictions": [
{ "label": "Strictly 21+", "description": "Valid photo ID is required at the door." },
{ "label": "No outside food or drinks" }
]
}
}

Every successful response has success: true and the result in data. Errors are described in Rules and limits.

The first URL in photos is the cover photo. restrictions lists the venue’s house rules; description on a restriction is optional.

The API is available only while the venue is listed on the marketplace and has at least one published active space. Otherwise every request returns 404 with the message This venue is not available..

Requests from a browser are accepted only from the websites listed on the website key. During development, ask the venue to add your local address, for example http://localhost:3000, and to remove it before going live.

No other headers or authentication are required.

Follow the booking flow.