Getting started with Access MicrOpay Web API, you will fall into one of the following categories:

• A Software and Service Organisation (SSO) with an Access MicrOpay customer who wants your product to work with the Access MicrOpay Web API (the Web API)
• An SSO, that does not support MicrOpay customers, that wants to add support for the Web API to your product.
• An Access MicrOpay customer who wants to start using the Web API. Please refer to Getting Started as a MicrOpay Customer for more information.

Programming the Access MicrOpay Web API

Our approach is to provide access to a test API environment that simulates the Access MicrOpay Web API. This allows you to test your product and familiarise yourself with payroll responses to the API calls. Then, when you have tested thoroughly and are comfortable using the Web API, we will assist with the setup and credentials required to move to production.

Getting Started

To get started testing the MicrOpay WebAPI with your solution/system, you will need:

• The latest MicrOpay version
• The latest version of the MicrOpay Client Services (MCS) software
• A test MicrOpay payroll database
• Credentials to use the Access MicrOpay Test API (sandbox environment) site

Latest MicrOpay and MCS versions

The latest MicrOpay and MCS versions can be downloaded from the Product Updates page of our website.

Test MicrOpay payroll database

If required, we can provide you with a test database that is hosted in our Payroll Online environment.

Alternatively, if you are an SSO with a MicrOpay customer, you may wish to use a copy of their/their customer’s payroll database for testing.

A test MicrOpay licence may be required.

Test API Credentials

The process of requesting Test API credentials differs slightly depending on whether you are an:

• SSO already supporting or about to support a MicrOpay customer
• SSO without any MicrOpay customers but would like your product to integrate with Access MicrOpay, via the WebAPI.

For an SSO with MicrOpay customers

Please ask your MicrOpay customer to request Test API credentials by raising a case through our Customer Success Portal

The customer will be the primary contact for the case.

The request should contain:

• The customer’s Access Group Customer ID number
• The details of your company and the software product that will be integrating with MicrOpay
• The intended use of the Web API
• Whether or not you will require a test database or the customer will be providing their own.

For an SSO with no MicrOpay customers

Please register a Customer Success account via HERE and log a case that contains:

• Details of your company and software product
• Best contact person, with contact details
• The intended use of the Web API

The Subject line of the email must read: Access MicrOpay WebAPI Integration Proposal. You will receive a reply from the Access MicrOpay Product team, after they have reviewed your proposal.

Synchronise accurate data with the Access MicrOpay database

Each Access MicrOpay database can be tailored to suit the user’s needs, so it’s very important to understand what data can be manipulated by Access MicrOpay payroll users, and synchronising this data with your software for each client. To do this, you will need to be able to store the codes and descriptions that match up with the Access MicrOpay database, and send the codes through with change requests. To make this easier, you can get a full listing of the current codes and descriptions through our Access MicrOpay Web API. In normal Access MicrOpay usage, these codes change and are updated regularly.

Once you have your code working with the example data on the sandbox site, you should be ready to use this code in production with a Access MicrOpay client. To move to production:

• Access MicrOpay client(s) will need to setup an account
• Access MicrOpay client(s) must install their client service on the payroll database
• Access MicrOpay client(s) must authorise you as a Software & Service Organisation provider, and specify the API calls you will get access to
• A production username, password and ApiKey will need to be optained for each Access MicrOpay client you need access to.

Synchronise accurate data with the Access MicrOpay database

Each Access MicrOpay database has the capability of tailoring their data to suit their needs, so it’s very important to understand what data can be manipulated by Access MicrOpay payroll users, and synchronising this data with your software for each client. To do this, you will need to be able to store the codes and descriptions that match up with the Access MicrOpay database, and send the codes through with change requests. To make this easier, you can get a full listing of these codes and descriptions through our Access MicrOpay Web API, which get updated regularly from each Access MicrOpay database.

To get a better understanding of what data is involved you can:

• Review the help for each of the Access MicrOpay Web API calls you plan to make. The documentation makes it clear which fields need a matching Access MicrOpay code, and which lookup type you’ll need to call to find the matching codes and descriptions. The help also shows the expected values for enumerated fields, that have a range of possible values regardless of which Access MicrOpay database you are connecting to.
• Work through the examples page. The examples page helps identify some of the lookup code fields, how to lookup the codes and descriptions for those fields, and how to pass those values through to the Access MicrOpay Web API.

Simplify data entry for your application

With an understanding of what codes and descriptions are needed to be synchronised with a Access MicrOpay database, there is also an opportunity to simplify data entry for users before sending data to the Access MicrOpay Web API. The most obvious advantage could be to use data from the lookup APIs to populate lists for use in your application. As an example, rather than an edit box for users to type their work location, having a work location drop down box, with all the values coming from the Access MicrOpay Web API.

This data is generally not edited often, so the suggested approach would be to get this data from the Access MicrOpay Web API daily, and save that data locally in your database for your lookups throughout that day.

This way your users get to use the same drop down lists used in Access MicrOpay products, and don’t need knowledge of matching codes and descriptions when adding new employees or applying for leave, as well as not getting their data rejected by the payroll software.