Connecting Astute to Onboarded
Create API user in Astute to collect API Key, API Username and API Password:
To allow Astute to connect with your Onboarded instance, you will need to set up an API key, username, and password. Onboarded uses these details to allow the flow of data into Astute, so you will need this information handy. In Astute, to create a Portal Administrator profile for Onboarded to access your portal, do the following:
Go to Users > Staff/Admins > Create New User.
Set the Profile Type as Administrator with the below username details:
First Name: Onboarded
Last Name: API
Click Create User.
Enter a Primary Email Address for the password to be sent to.
If you have multiple entities, go to the Job Details tab and select an Associated Entity from the drop-down list.
Click Save and Activate.
Retrieve the email and login, and complete the password setup. Ensure you also set up Two Factor Authentication (2FA) to keep your portal secure. Store the password securely, as you will need to connect to Onboarded.
Once the password has been set up, email [email protected] requesting that full API access be enabled on the new profile. Please include the portal URL and the name of the profile in the email.
Once our Support Team has confirmed this has been done, you are ready to connect to Onboarded.
The API key will be the first part of the URL (eg yourportal.astutepayroll.com will have an API key for your portal).
API Username as per the administrator account you set up (onboarded.api)
Password as per the administrator account you set up.
Establish your connection from Onboarded
In your dashboard, click on the cogwheel located in the top right corner. Only admin users can see the cogwheel.
Click on General Settings from the dropdown menu.
Once in the General settings tab, scroll down to Payroll Integrations where you will be able to see Astute payroll.
Click on the Connect button.
In the Pop-up window enter the following information you have sourced from Astute:
Click on the Save button.
📌Note: If any of the details are incorrect, it will not connect. |
You are now connected with Astute, as the connect button will change to the Red disconnect button: