RESTful API

The AEO web-server’s base URL consists of the web-server’s name and port number followed by the web plug-in name. Example: https://<servername>:<port>/oc_main/aeo

The plug-in name is configurable and the default value is ‘aeo’.

To perform any operation or access any information from AEO web-server, the client first needs to ‘login’ and use the same login session for further requests.

Documentation

Documentation for the RESTful API can be found under the main menu.

From the page displayed, a list of all api calls is available along with a list of parameters that can be passed to each call.

Examples of each API are displayed but cannot be currently run from the swagger page .

Use Cases

  • The localhost can be the machine hostname or IP address.
  • The URL can be https or http based on SSL configuration.
  • A Login script is required for executing all the mentioned scripts if it is executed for the first time.