Configuration API and Data API

Introduced in version 3.0, the Configuration API (Config API) and Data API together form the crux of AVEVA™ Integration Service. Config API enables you to work with the data sources (or data source configurations) that have been added. You can view the data sources, retrieve the information about a data source and delete a data source. The Data API enables you to work with the data of available data sources. Users can retrieve, update and post data using the Data API.

The APIs can be installed on any server computer in your network but ideally it must be installed on a computer that is located in a central region to ensure minimum latency for users. Also, to ensure data security, only authorised users (administrators) must be given the Write access to the server. Users, authenticated through NTLM, can be given the Read access to connect to the APIs and retrieve the required information.

The information about the data sources is stored in a db file called AISSecure AISDatasource.db/AISDataStore.db Files whereas the data is stored in a file called AISdatastore.db. Updates to the files are possible only through the Configuration API and Data API respectively. The files also can be installed on a separate computer if desired. For information on how to move the db files to a different location, see Change Installation Location of Config API/Data API and Secure AISDatasource.db/AISDataStore.db Files.

Before starting the Service, you must be connected to the Config API and Data API.The API URLs is comprised of the computer name (machine name) of the computer on which the APIs are installed and the port number mapped to it. You must replace the default "localhost" with your machine name in the URL.

By default the Config API and Data API use the 60920 and 60930 ports respectively. If you want to configure different ports for the APIs, you can do so using IIS Manager. If you have not changed the ports, then you can leave the port numbers as is.

The following image provides high-level steps for configuring a different port number for a URL in IIS Manager.

Both APIs are accessible through HTTPS and follow the IIS URL authorization rules. Therefore, your data is secured from unauthorized access. Further, both APIs support NTLM authentication which you can leverage to further secure the data.