Solution

Prerequisites:

1. The Gensolve API functionality must be turned on for your organisation. Contact the Gensolve Support Team first before trying to complete the below steps
2. You must have sufficient access that allows you to edit Access Roles to setup API Users.

WARNING:  Giving any third party access via the API to your Gensolve means you are allowing that third party to access your Gensolve data to GET, POST and PUT information in your Gensolve System and any external place you agree on. It is your responsibility to ensure that you understand this and that security and privacy policies in your country are followed.

Contact Gensolve Support Team

1. Contact Support to have API Access turned on and have your Secret Key generated. Once you have received confirmation from the support team continue with the steps below.

Create a New API Access Role

1. Click on Administration >> User Access Roles >> New Access Role
2. In the Role field >> Type WellNow API
3. Enter a Description
4. On the Windows tab scroll down and tick the API Options as per below.  If you do not see the API Contract Export it is not relevant and can be ignored.
5. Scroll down further and select the Administration Menu tick box.
6. Click Save

Create A New User for WellNow API Access

1. Administration Menu >> System Users >> New System User
2. Enter the Display Name as WellNow
3. Enter the User Name as WellNow
4. Enter a Password and then re-enter the Password >> Note: You will need to use this login to complete the API Access & to provide these details to WellNow, so make sure you make a note of the User and Password.
5. Click Save >> The User Setup screen will close
6. In the All System Users table find the WellNow user just setup. Click on the first  to the right of the user.
7. Select the Access Privilege >> Role – WellNow API that we created earlier as per below >> Click Save.

8. With the WellNow user selected click the second to the right of the user.

9. Select the sites that the WellNow API Team will require access to.

10. Click Save

11. Logout of Gensolve

 

Update the WellNow API Access Endpoints

1. Login using the above created WellNow user and password
2. Go to Administration >> User Access Roles >> Edit the WellNow API user access role created earlier.
3. Click on the API tab.  (if you do not see the API Tab you have not followed the steps above and are not logged in as the API user).
4. Click on the Endpoint drop down menu >> Select the Endpoints listed in the below screenshot.
5. The Method should automatically fill for each Endpoint
6. Click on the Add button once each Endpoint is added
7. The Endpoint and the Methods setup will now appear as per below >> Click Save.

8. The WellNow Access Role has been updated with all the permissions and access they require.

Configure and Test the API User Setup

1. Administration >> API Configuration >> Refresh Data

2. Under Access Roles with API Access click on the row with the WellNow API role >> the Users and Endpoints will display below in the Users with Access Roles and Endpoints this Access Role Allows.

Note: These following steps are IMPORTANT.  Failure to complete these IP Address steps will STOP the API Configuration from working.

3. Under IP Addresses click Add an IP Address

4. In the IP Address field enter * >> click Add IP Address

5. At the Add IP Address pop up click Yes

6. An exclamation warning will appear next to the IP Address.  This is as intended.

7. Next to the WellNow User click the icon.

8. Enter the Password you created earlier for this user >> click Test Connection

9. A pop up will appear click OK.

10. Click the X icon to close the Test Connection window.  The API Configuation is now complete.

Provide Information to WellNow

You must now provide the requested information to WellNow.

1. The API Secret Key shown at the top of your API Configuration Screen.
2. The API Base URL : https://nzapi.gensolve.com

3. The User Name you created for API access : WellNow
4. The User Name Password for that login
5. Any other details such as Organisation name and Vendor name