The Employgroup API is a REST-based service that provides authorised third-party applications the ability to access data stored by Employgroup. This data can include employee personal data, time and attendance, payroll data etc.
To ensure the security of your company data, and to maintain the integrity and availability of our systems, a number of steps must be completed before access to our API is allowed.
- Step 1: Apply for an API Token
To access the API, you will need an API token. In order to apply for an API token, please download and complete an API Token Application Form. You will need to forward your completed API Token Application Form to email@example.com.
We will review your application, usually within 72 hours, and will contact you if we require further information. After your application has been approved, we will supply you with:
- Your unique API Token; and,
- The login details to access the API dashboard and documentation.
While you are waiting for your application to be approved, we recommend that you read the following documentation:
- Step 2 : Configure your software and test
After your API Token Application has been approved, you will be able to log in to our API Dashboard and Documentation Portal. This portal provides documentation for each of the end points that are available within the API, and gives you the tools you need to monitor your usage of the API.
You will need to use this documentation to build the integration with Employgroup from within your application.
You will also need to test your application integration against our Sandbox API at https://apiuat.epayroll.com.au.
- Step 3 : Update your software to use the Production API
You will need to install your digital certificate on your server that will be calling the API. You will also need to update your API calls to use the Production API at https://api.epayroll.com.au.