Authenticating

In order to use SAPI you will need an API key. An API key is like a password that identifies your application when sending requests to our server. If you are developing multiple applications that will use the API, we request that you apply for a separate API key for each.

Getting an API key

To obtain an API key you must register for an account on the Sensis® Developer Centre portal.

Once you have registered and activated your account, you will be automatically sent a test api key. A test API key allows you to start calling the API immediately, and should be used for testing during development. However, once you have built a production-ready application or website, you will need to apply for a production key. A production key allows for a much greater volume of calls than a test key, and must be used when your application is released for public use.

To apply for a production key, please send an email to api@sensis.com.au.

You can also view your API keys on the My API Keys page at any time.

Important: Because API keys are linked to you and your application, you should keep them private. Avoid exposing them in URLs or anywhere in your web page mark-up. If you would like to do AJAX-based searches, we recommend proxying the search requests through your own server.

Using your API key

When calling an endpoint, you specify your API key as an HTTP GET parameter called key.

For example, if your API key was 'abc123', your request URL may look like:

http://api.sensis.com.au/v1/test/search?key=abc123&...

If you do not specify an API key, or the value is incorrect, the API call will fail with:

  • An HTTP status code of 403 (Forbidden)
  • An HTTP header called X-Error-Detail containing the message 'Account Inactive' (or similar)
  • A JSON message similar to:
    {
        "code": 403,
        "message": "Account Inactive"
    }

Note: You can also receive HTTP 403 status codes if you go over your limits. See Limits for details.