How can we help?
< All Topics
Print

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 our 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
  • Business Directory – to create a business directory

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.

Permitted Use of the APIs

The Website 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, e.g. for websites to be making requests in real-time. Therefore any website using the APIs must be able to receive and store data. You will also need to agree the timing and frequency of the API requests with Loqiva so demand can be managed effectively.

Please note, our Website APIs can only be used if you agree to our terms of use. Please make sure you read these in detail, and only proceed with using our APIs if you are in full agreement with them.

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

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. {“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″}”)

3) Business Directory

The Business Directory API provides the following response:

BusinessName – string (e.g. “The Local Dentist”)
Address – string (e.g. “60 High St, TownName, D02 7PY, UK”)
Url – string (e.g. “https:\/\/www.thelocaldentist.com\/”)
Telephone – integer (e.g. “+447701234567”)
Description – string (e.g. “<p>An excellent local dentist for your area.<\/p>”)
Longitude – integer (e.g. “0.8962039”)
Latitude – integer (e.g. “51.8170768”)
MediaURL – string (e.g. “https:\/\/hub.loqiva.com\/public\/images\/maps\/filename.jpg”)
Category – (e.g.”SERVICES”)
SubCategory – (e.g. “Dentist”)
WorkingTime – (e.g. {“Day”:”Mon”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″},{“Day”:”Tue”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″},{“Day”:”Wed”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″},{“Day”:”Thur”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″},{“Day”:”Fri”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″},{“Day”:”Sat”,”OpeningTime”:”09:00:00″,”ClosingTime”:”17:00:00″})

NB: We can also supply a separate categories API to enable you to sort and filter the businesses using Category and SubCategory.

Further Information

Please feel free to contact us for any queries or support based upon your use case.

Table of Contents