How to get there
To access the 'API Integration' feature, a user must be an admin and signed into the
GoContractor admin portal. The admin must also have access to the top level division
of the account.
Use the left had menu to select 'Settings'. At the bottom of
the settings menu is 'API Integrations'. Click it to open the menu.
API Integrations
When open, select 'Manage API Keys'.
This will open a screen where API keys can be both edited and created.
Creating an API Key
- Click the blue key/+ icon on the right
- This will open up a new key form to fill in
- Each key requires a unique name
Allow Writes
This setting will 'Allow those using the API key to create, update, and delete data on your account. When disabled, the key is restricted to read-only API calls.'
Can Read Qualification Data
This setting when enabled, means that non-sensitive worker qualification data will be included in the results of the worker endpoint. Read more about this here.
Expiry date
An expiry date is not mandatory how ever may be useful security wise to have one.
Select Projects
The projects selected will be used to extract the data desired.
When complete - click 'save'.
A new key will be created and a new screen will appear which will display the API Key.
This screen will not be accessible once closed.
It is essential to copy the API key before exiting the screen.
Use the copy icon to copy the API key.
Select 'done'.
Editing an API Key
To edit an API key
- find the key to be edited
- click the key open
The following settings can be edited
- 'active' or 'inactive'
- key name
- projects (note that at least one project must be selected at all times for a key)
- expiry date
- allow writes
- can read qualification data
- the key can also be deleted by selecting the 'Delete Key' button
After making the changes select 'Save'.
Learn More About GoContractor APIs
To read in more detail about GoContractor APIs please visit our the API Documentation here.
If you have a question about API Keys please email us at support@gocontractor.com
Thanks for reading !