plazz.me Convert places to short URL's and share them with Plazz.me

API Documentation

Overview

We provide two fairly basic APIs which can be used in order for other applications to use our service. This works by accessing a particular URL, that accepts an address or Geographical Coordinates as a parameter, and the response is a short URL (or an error message).

Submitting an Address

Your application simply have to access a URL via an HTTP GET request, passing the address or coordinates as a parameter:

• http://plazz.me/api/balmes 1, Barcelona
• http://plazz.me/api/41.234,-1.9887

Receiving the short URL

After submitting the Address (or coordinates) you will receive, as specified above, an HTTP response. The response header will be "HTTP/1.1 200 OK" if the Address was found as expected, or "HTTP/1.1 500 Internal Server Error" if there was any problem.

Assuming the request was successful, response's body will contain only the short URL, in plain text.

Possible errors

If the request was unsuccessful, the body of the response will contain a message: "Error: The Address entered was not valid."

Encoding

In general any special characters in Addresses or Coordinates you send as a parameter, may either be sent encoded or not.

Terms

Application authors should note that users of the plazz.me API are expected to comply with the same terms of use as users of the website.

Conditions on excessive usage still apply - the API is primarily intended for use in low volume applications and applications such as browser plugins, scripts etc. that run on the machine of an end user. Single machines making several thousand API calls every day without having specifically asked permission to do so risk being blocked from the service without notice.