Difference between revisions of "Working with existing API partners"
| Line 1: | Line 1: | ||
[[API Details| Go to API overview]] | [[API Details| Go to API overview]] | ||
| + | |||
If you are working with a 3rd party software company who has used our API before, all you need to do is create a user for them, and provide them with the API keys. For a detailed explanation of API Authentication, see [[API_Authentication| API Authentication]]. | If you are working with a 3rd party software company who has used our API before, all you need to do is create a user for them, and provide them with the API keys. For a detailed explanation of API Authentication, see [[API_Authentication| API Authentication]]. | ||
Revision as of 16:25, 18 March 2021
If you are working with a 3rd party software company who has used our API before, all you need to do is create a user for them, and provide them with the API keys. For a detailed explanation of API Authentication, see API Authentication.
1. Create a new user. An API user has the same access controls as a user of the web application, with the exception of "See my own clients" restrictions. See Users for more detail.
2. Consider un-ticking the box on the Website Access tab, if you only want this user to have access to your data through the API. A password is required regardless, but this can be ignored in this instance, as the API user will use keys for authentication instead.
3. On the 3rd Party System Access tab, tick the name of the company you are working with. This will generate the API keys, then click the Reveal Key button, and provide your software supplier with the keys. Remember that keys need treating with the same level of security as passwords. If you want to change the keys at any point, un-tick the box, and tick it again.
Remember that as a system adminstrator, you are responsible for controlling the access rights of all your users, including API users, to ensure they only have access to the data you want them to see.
