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

Getting Started With The Vestigo API

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.

Webinar recorded in 2025.

How It Works

    • Data Access: The client site sets up a user with API permissions. The user will generate an API key that will only be visible once. After the page is navigated away from, it will not be able to be retrieved again. If the key is lost, a new one must be generated. The user will access the site via endpoints in the API, which are specific URLs that correspond to different data resources (e.g., user accounts, inventory details, dispensing history, etc). When a request is made to an API endpoint, the site responds with the requested data in a structured format.
    • Data Retrieval: External applications (like analytics tools or dashboard platforms) make requests to these API endpoints to retrieve the necessary data. This is usually done by someone in IT for the site.
    • Metrics Generation: Once data is retrieved through the API, external applications can process and manipulate it. For example, it could be used to calculate metrics such as averages, totals, percentages, or trends, which are key to building insights.
    • Dashboard Creation: With the data in hand, external tools can then create visualizations like graphs, tables, or charts. These visual elements are placed on dashboards, which provide an easy-to-understand summary of key metrics and trends.
    • Real-time or Scheduled Updates: The Vestigo API support real-time or periodic data updates. This allows dashboards to stay up-to-date with the latest information, providing users with accurate and timely insights.

The Vestigo API would be able to accomplish what your IT team is looking for in the scheduled runs for the user accounts and roles, but additionally, it would be able to provide other useful information that you could use to help with metrics for your site.

The Vestigo API is a contracted add-on and if you are interested in this, please contact your Customer Success Manager or reach out to our support email, support@mccreadiegroup.com.