Edit TOP Server Runtime Configurations from Third-Party Applications

Tighter integration between TOP Server and your third-party custom applications

The Configuration API in TOP Server provides the ability to programmatically read and update the configuration in TOP Server from other software applications.

The Configuration API allows you to read, create, update, and delete channels, devices, groups, meter groups, tags, and select plug-ins.

The Configuration API is available for all supported functionality as a RESTful JSON web service or for select drivers and plug-ins as a .NET API (Contact Us for .NET API Details)

Typical Configuration API User Stories

The following are some key examples of they types of situations power users have told us about where access to the Configuration API is beneficial:

  • Enterprise Users with large projects that are changing constantly, such as in upstream oil & gas where assets are constantly being added and removed or moved.
  • Enterprise Users with other software applications, including in-house applications or other configuration tools they would prefer to use to manage the TOP Server configuration and maintenance process.
  • Machine builders seeking to automate changing of machine configurations across different customers or markets.
  • System Integrators seeking to reduce engineering cost through automation of routine, repetitive configuration tasks
  • System integrators seeking to offer their users limited and simple access to certain routine configuration actions
  • Users that need to limit what certain users can do beyond the capabilities of the built-in TOP Server User Manager and want to limit even what the user can see, or present the configuration information in alternative formats that are more meaningful to their users.

RESTful API Key Features

  • Full Create, Update, and Delete operations (CRUD) on
    • Channels
    • Devices
    • Tag Groups
    • Meter groups (specific drivers)
    • Tags
    • Aliases
  • Object definition using JSON data format
  • Transaction logging with configurable levels of verbosity and retention and API access to the transaction log
  • Secure Out-of-the-Box:
    • Disabled by default
    • HTTPS endpoint support
    • HTTP endpoint disabled by default
    • TLS cipher support (TLS 1.0, 1.1 and 1.2)
    • SSL certificate support
    • Filtering by source domain
    • HTTP/HTTPS basic authentication
    • Integrated with TOP Server User Manager and Securities Policy Plug-In for granular rights control
  • Built-in documentation describing the endpoints and valid configuration properties.
  • Support for all drivers (some limitations may apply)
  • Current support for the following plug-ins:
    • Media Level Redundancy
    • Scheduler
    • EFM Exporter
    • Datalogger
  • Events/Error retrieval from event log via API
  • Access/Modify User Manger users, groups and passwords via API
  • Support for configuring TOP Server Project Properties

    .NET API Key Features

    Recognizing that many of our users are .NET developers, Software Toolbox offers an object oriented .NET wrapper for the RESTful API for users who develop in Visual Studio.NET and do not want to have to handle the management of the calls to the RESTful web service and serializing and de-serializing of the JSON packets.

    The goal is to provide these developers a rapid development environment that allows them to focus on the configuration tasks, not the plumbing of implementation of the API.

    • Single .NET namespace consumable in Winforms, WPF Forms, Console, Service, and ASP.NET applications or applications supporting .NET Framework 4.0 or higher.
    • Object-oriented operation treating configuration items as objects: channel, device, tag group, meter group and tags
    • Complete management of the web service connection and serializing, de-serializing of the JSON messages and objects
    • Simplified command set designed to reduce development time.

    If you have a use case for adding TOP Server configuration capabilities to your .NET applications, please contact us for a demonstration and evaluation of your project needs.

    Important Notes:

    • The RESTful API is included with any TOP Server license at no additional charge.
    • The .NET API wrapper is a supplemental option requiring additional licensing fees - contact Software Toolbox to discuss pricing for the .NET API.
    • Usage of the Configuration API requires custom development by the end-user to access TOP Server
      • Standard support/maintenance for TOP Server does NOT include support for troubleshooting and debugging any custom code attempting to use the Configuration API (RESTful or .NET).

    Get Started Now

    The demo is the full product once licensed. Once a client application connects to the  TOP Server, the TOP Server runtime will operate for 2 hours at a time. At the end of the 2 hour demo period, the demo timer must be reset by restarting the TOP Server runtime service.

    Connect with Us

    1-888-665-3678 (US + Canada toll free)
    +1-704-849-2773 (Global)