API Reference

Basics contents

Zeus API is a REST based api born to allow data integration between Microcom devices and your own SCADA or application.

The API is HTTP-based with own encryption so it is not necessary to use HTTPs, and is itself responsible for maintaining the security of data and communications. The API allows the exchange data between applications and ZeusServer, reading and writing different resources. The exchanged data is in JSON format.

URL

The URLs in the API have the following base:

  • version: is specified by the letter 'v' followed by the version number. So for example we would have v1, v2.1, v3.1.2...
  • collections: collections of resources.
  • object-id: individual objects, each with a unique ID. Not all URLs have this parameter. Must be URL Encode.
  • resource: Not all URLs have this parameter.
  • filters: list of key-value pairs separated by the character '&'. You can select parameters to indicate certain conditions of the request for example timestamp. Not all URLs have this parameter.

Each element ot the URL must be URL encoded.

Collections

  • Accounts: You can get your authtoken to authenticate each of the requests you make to ZeusServer through your authaccount, authpass and your user password. You can obtain your authaccount and authpass once logged on ZeusWeb, going to URL: api_credentials.html.
  • Stations: This collection contains information about the station objects. With this collection you can consult online stations, their properties or select the latest known values.
  • Historicals: This collection contains information about historical objects. With this collection you can receive or send the historical data of a specific station.
  • Alarms: This collection contains information about alarms objects. With this collection you can receive or send the alarm data of a specific station.
  • Messages: This collection contains information about messages objects. With this collection you can receive or send messages from/to a station.