Getting Started

Welcome to the Department's Employment Developers Portal, which provides a way to interact with the ESS APIs.

The table below details the different exploration phases that will support you in developing your application :

Phase

Exploration

Development

Production

Who

All users who would like to know more about the Department's API offerings

API developers

Contracted Providers, Accredited Third Party Consumers

What

  • Get familiar with the concepts of User Types, Environments  and Products in this page

  • Check out the APIs available in the Under Construction product

  • Check out the guides for the different APIs

  • Read through the recommended steps for your User Case

  • Contact us if you have questions

  • Request a Developer Service Identity to access the APIs

  • Develop your application using the JSON schemas which can be downloaded from the APIs in the Under Construction product.

  • Test your developed application in the Under Construction environment using the developer service identity

  • Understand the requirements for a GUID to be provided with all PUT and POST requests.

  • Set up your production portal account using a generic email address.

  • Create subscription request(s) to access the live products.

  • Monitor your usage and any errors you might be seeing using the built in Analytics on the developer portal. You will be able to see the data for all your subscriptions.