Monday, 3 May, 2010

The Space Database API

Space Database drawing and availability data is published to the web in many different ways and through many different websites. Here are some examples of stacking plans and availability reports. In most cases we have written custom pages that are hosted on our server and embedded in our clients' websites.

Recently we've had enquiries from our clients web designers about getting access to raw data and providing them with more control over the display of this data. We have provided some customized XML data in the past and we thought we should elaborate on this and develop a comprehensive API.

API stands for Application Programming Interface. It is the 'interface' of a software which allows it to interact with other software. An API allows other programmers to write code that will interact with the software and to access data from it. In our case, the Space Database API allows web site designers to pull current data from our server and then format it any way they want. They will be able to use the data in their own applications and they will be able to do this remotely across the web.

Internally we will also be using this new API. We will be converting all of our small data driven pages that provide content to client sites to also use this API. This will 'encapsulate' or hide the backend system from the front end web pages. This means that when we make changes to our backend - such as the major upgrade planned for this summer - none of the front end pages will be effected, or need to be edited.

So what exactly will you be able to get from the Space Database API?

Initially we will be offering three services. They will be provided as XML (extensible markup language), as well as JSON (JavaScript Object Notation). These two formats will allow programmers to choose different technologies to consume the same data. The three services will be:

  • Get Building Details This service provides details on a particular building that we have in our database including description, amenities, photos as well as longitude and latitude information.
  • Get Suites List This provides a list of spaces in a building. Only available space includes suite numbers and detail. Enough data is provided so that a developer could create a stacking plan or an availability report.
  • Get Suite Details This service provides details on a particular vacant space including description, rental rates and a URL to a marketing drawing.

Over the coming months we will be adding more functionality to our API. Our goal is to give clients the ability to use their content however they see fit. We want to help them maximize the value of their data.

0 comments:

Post a Comment