Interactive tutorial: Generate a User API Key
1. Welcome to this tutorial covering how to Generate a User API Key in the Gateway.
If the user requiring an API key is associated with multiple locations, DO NOT FOLLOW THIS PROCEDURE. Instead, contact Support, who will set up the user's API key under the main account and all other associated locations.
2. Generating a Single Location User API Key
Start by clicking Locations.
3. Note
If you have access to multiple locations, you can enter search terms in the Filter Boxes to help find the desired location.
4. Click the Location Name to open the details view.
5. Click Settings.
6. Click Users.
7. Note
If you have access to multiple users, you can enter search terms in the Filter Boxes to help find the desired user.
8. Click the Username to open the details view.
9. Scroll down and click Edit.
10. Scroll down and click New Key in the User API Key field.
11. Note
This is the only time the User API Key will be fully displayed. If this key is lost, it cannot be retrieved, and a new one will have to be generated. It is highly recommended to copy and save this key value for future reference.
12. Click Ok to confirm.
13. Click Save.
The user's new API Key is now active.
Admin Only Method
14. If you are an Admin you can use the Support menu to generate a user's API key.
15. Start by clicking Support.
16. Scroll down and click Users.
17. Note
If you have access to multiple users, you can enter search terms in the Filter Boxes to help find the desired user.
18. Click the Username to open the details view.
19. Scroll down and click Edit.
20. Click the New Key button in the User API Key field.
21. Note
This is the only time the User API Key will be fully displayed. If this key is lost, it cannot be retrieved, and a new one will have to be generated. It is highly recommended to copy and save this key value for future reference.
22. Click Ok to generate the key.
23. The new User API Key is now active.
If you have any questions or need additional assistance, please check out our knowledge base for additional resources or reach out to your support team.
Thank you for watching!