Skip to content
English
Contact Us for Support
  • There are no suggestions because the search field is empty.

Creating an API Management Security Role

Vestigo provides an API (Application Programming Interface) for pulling data, it allows external systems, such as other websites or applications, to request specific data stored on the site in a structured way.

When implementing the Vestigo Reporting API, it is recommended to create a new Application Role (ie: “API Management”) that specifically has permissions to manage the API user account and secret. This role should only be applied to a user if they have responsibility of managing the API account. For more information on creating an Application Role, please review our Application Role Creation article.

This role only needs to have two permissions:

  • VestigoAPIManagement - Create and manage Reporting API accounts 
  • AdminMain - Access the application administrative menu 

These will provide the user access to the “Vestigo API” link on the Application Administration page.

 

Once this is done, a local Vestigo system administrator will have to create and assign that role in each facility where they would want metrics from. To create an account, please reference this article.