Website APIs

Why would you wish to use Website APIs?

Most place management organisations have a website to support their town or city.

If you would like your website to mirror content from your Digital Town Hub, then you can do this using Website APIs.

Loqiva offers customers the ability to synchronise data with websites in relation to:

• Events – for What’s On sections
• Offers – to help promote the latest offers from local businesses

How to Access the APIs

If you wish to use Website APIs, you need to request these from Loqiva. We will set these up and provide you with dedicated API keys for your web developer to use. Details of the keys will be stored in Settings > Outbound APIs.

Permitted Use of the APIs

The APIs have been created so that data can be synched at regular intervals (e.g. daily or weekly) between systems. They are not designed to be used by end users, i.e. making requests in real-time. Any website using the APIs therefore needs to be able to receive and store data.

1) Events

The Events API provides the following response:

EventID – integer (e.g. “4085”)
EventName – string (e.g. “Macbeth”)
EventDescription – string (e.g. “In this modern-day production …)
VenueLongitude – integer (e.g. “0.8962039”)
VenueLatitude – integer (e.g. “51.8170768”)
EventVenueName – string (e.g. “Kings Theatre”)
VenueAddress – string (e.g. “DO2 7AT, TownName, 20 Chapel Street North”)
EventStartDate – string (e.g. “2024-05-24”)
EventStartTime – string (e.g. “19:45:00”)
EventEndDate – string (e.g. “2024-05-24”)
EventEndTime – string (e.g. “19:45:00”)
EventWebsite – string (e.g. “https:\/\/www.kingstheatre.com”)
EventCategory – string (e.g. “Talks & Tours”)
EventShowMapLink – string (e.g.”true”)
EventShowMap – string (e.g. “true”)

2) Offers

Response – Available Data

The Offers API provides the following response:

Title – string (e.g. “Happy Hour”)
Description – string (e.g. “Enjoy our incredible range of …” )
URL – string (e.g. “https:\/\/www.doganduck.com\/”)
Longitude – integer (e.g. “0.8962039”)
Latitude – integer (e.g. “51.8170768”)
Address – string (e.g. “60 High St, TownName, D02 7PY, UK”)
BusinessName – string (e.g. “Dog & Duck”)
MediaURL – string (e.g. “https:\/\/hub.loqiva.com\/public\/images\/maps\/filename.jpg”)
Category – string (e.g. “pub”)
WorkingTime – (e.g. “”WorkingTime”:[{“Day”:”Sun”,”OpeningTime”:”11:00:00″,”ClosingTime”:”00:00:00″},{“Day”:”Mon”,”OpeningTime”:”11:00:00″,”ClosingTime”:”00:00:00″},{“Day”:”Tue”,”OpeningTime”:”11:00:00″,”ClosingTime”:”00:00:00″},{“Day”:”Wed”,”OpeningTime”:”11:00:00″,”ClosingTime”:”00:00:00″},{“Day”:”Thur”,”OpeningTime”:”11:00:00″,”ClosingTime”:”00:00:00″},{“Day”:”Fri”,”OpeningTime”:”11:00:00″,”ClosingTime”:”01:00:00″},{“Day”:”Sat”,”OpeningTime”:”11:00:00″,”ClosingTime”:”01:00:00″}”

Further Information

Contact us for further information and supporting documentation.