PlanningAlerts API changes

Starting today, we’re beginning to roll out a change to the way the PlanningAlerts API works. We’re introducing API keys for all users of the API from low-volume non-commercial users to high-volume commercial users. We are making this change so that we can better measure and understand the way people are using the API as well as give us the ability to contact all API users in case of any issues (or changes we make) that might affect them.

We’re phasing in the introduction of API keys. Right now they are optional, though as a new user of the API you will be guided into using them.

On 1st of June 2015 the use of API keys will become mandatory

3 months from now on 1st of June 2015 the use of API keys will become mandatory.

This means if you are a user of the API today, you will need to move over to using API keys before 1st of June 2015. If you don’t do it by then the API will stop working for you on that date.

We’ve made it very easy for you

Thankfully, we’ve made it very easy for you to get an API key.

  1. Simply register for an account on PlanningAlerts
  2. Then visit the normal API documentation page to see your API key
  3. Update your API calls adding &key=[your key]

We recommend you don’t use the PlanningAlerts api via client-side javascript

If you use the API in client-side javascript you will obviously be sharing your api key with the world which is a very bad thing. It is your responsibility to keep the api key safe and secure. If we discover any abuse of a key (e.g. someone else is using your key) we will cancel the key and you will have to get another one.

As a result we recommend you don’t use the PlanningAlerts api via client-side javascript.

Either

  • Switch to getting the planningalerts data server-side where you won’t expose the api key
  • Or proxy the client-side requests through your own server where you add the api key

If you have any questions on how to do this, of course don’t hesitate to get in touch with us.

This entry was posted in Announcement, PlanningAlerts.org.au and tagged , , , , , , , . Bookmark the permalink. Post a comment or leave a trackback: Trackback URL.

Post a Comment

Your email is never published nor shared. Required fields are marked *

You may use these HTML tags and attributes <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

*
*

Subscribe without commenting

  • Occasional News

    Stay in the loop with occasional news and notes from the OpenAustralia Foundation in your inbox.

  • Categories

  • Archives

    • [+]2018
    • [+]2017
    • [+]2016
    • [+]2015
    • [+]2014
    • [+]2013
    • [+]2012
    • [+]2011
    • [+]2010
    • [+]2009
    • [+]2008
    • [+]2007