Programmatic Access to SysTrack

Prev Next

This elective course describes how you can use the SysTrack API to retrieve data directly from a SysTrack database. This allows you to combine SysTrack's powerful data collection with third-party tools to enhance reporting and user experience.

You will receive a Certificate of Completion at the conclusion of this course. There is no certification exam for this elective course.

Sign in as a SysTrack customer to start this course.

Prerequisites

  • Basic Understanding of APIs: Know what APIs are, how they work, and be familiar with REST APIs, including concepts like endpoints, methods (GET, POST, etc.), and response formats like JSON or XML.

  • Familiarity with HTTP Protocol: Understand HTTP requests, responses, status codes, and headers.

  • Experience with API Tools: Proficiency with tools like Postman or cURL for testing API calls.

  • Knowledge of Authentication Methods: A working knowledge of API authentication mechanisms OAuth, or bearer tokens.

  • Basic Programming Skills: Familiarity with one or more programming languages commonly used to interact with APIs (e.g., Python, JavaScript, or Java).

Access Needed (to view in your environment)

  • SysTrack API keys

  • Service account credentials (if using legacy method)

  • SysTrack AI package and SysTrack AI (Partner) key (required to use SysTrack AI programmatic access and DEX Analytics MCP Server)

Course Objective

  • Use the SysTrack API to access SysTrack data

    • Generate the SysTrack API key

    • View a list of SysTrack API endpoints and documentation

    • Authenticate and use the SysTrack API via browser, Postman, and PowerShell

    • Run a SysTrack automation

  • Call the Audit API to view audit trail

  • Use the SysTrack AI Programmatic Access (SysTrack AI add-on package required)

  • Use the SysTrack DEX Analytics MCP Server (SysTrack AI add-on package required)

Course Outline

  • Course Overview

  • Introduction to SysTrack API

    • Why Use the SysTrack API?

    • What Data is Accessible?

    • What API Endpoints are Available?

    • Fair Use Policy

  • Authentication

    • What is API Authentication?

    • Authentication on Cloud Tenants

      • SysTrack API Key

    • Authentication on On-Premises Installations

  • Calling the API From a Browser

    • Use Case Examples:

      • What SysTrack Groups are Defined?

      • What Systems are in a Particular Group?

      • Getting Sensor Data From a System

  • Using Postman

    • What is Postman?

    • Setting Up Authorization

    • Running a Request

    • Visualizer Endpoints

  • Using the SysTrack API in PowerShell

    • Using the SysTrack API Programmatically

    • Cloud Example

    • On-Premises Example

  • Automations and Integrations

    • Running a SysTrack Automation Using the SysTrack API

      • Retrieving the Automation ID

      • Get the System GUID

      • Run the Automation

      • Monitor the Automation Execution

    • SysTrack API Integrations

  • SysTrack Audit API

    • Audit API Key

    • Audit API Endpoints

  • SysTrack AI (API, MCP, A2A)

    • SysTrack AI API

      • Authentication

      • Endpoints

    • SysTrack AI Model Context Protocol (MCP)

      • Tools

      • Connection Setup

      • Microsoft Copilot Studio Integration

    • SysTrack AI Agent to Agent (A2A)

      • Skills

      • Connection Setup

  • SysTrack DEX Analytics MCP Server

    • Tools

    • Connection Setup

  • Service Accounts (Legacy)

  • Conclusion

Tags: SysTrack API, Service Account, Audit API