Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Integration Service

TABLE OF CONTENTS

SDK Documentation

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 31, 2026
  • 3 minute read

This section can help you to set up and use the AVEVA Integration Service Data API SDK in your .NET project.

Supported Platforms

  • .NET Core 3.0+ (including .NET 5, 6, 7, 8)

  • .NET Framework 4.7.2+ (4.8 recommended)

  • .NET Standard 2.0 (for library compatibility)

  • Development Environment: Visual Studio 2019 or later

Pre-requisites (AIS SDK for .NET / C# Projects)

  • AIS installation: AVEVA Integration Service (AIS) must be installed and available in your environment.

  • SDK library access: The AIS SDK library AVEVA.IntegrationService.DataAPI.SDK.Lib.dll is supplied as a deliverable in AVEVA Product Support along with the AIS software.

  • Version compatibility: Use the SDK DLL that matches your installed AIS version (same release/patch level recommended).

  • Project type: Microsoft Visual Studio C# (.NET) project (Framework/.NET depending on your solution).

  • Permissions: You must have permission to download the AIS deliverables from Product Support and read access to the extracted files.

Installation / Setup Steps (Add the SDK DLL to a C# Project)

  1. Download the SDK deliverable

    1. Download the AIS SDK deliverable from AVEVA Product Support.

    2. Locate and extract the SDK package that contains AVEVA.IntegrationService.DataAPI.SDK.Lib.dll

  2. Copy the SDK DLL into your solution (recommended)

    1. In your solution folder, create a local folder, for example: .\libs\AIS_SDK\

    2. Copy AVEVA.IntegrationService.DataAPI.SDK.Lib.dll into this folder.

    This keeps the dependency under source control and avoids broken references across machines.

  3. Add reference in Visual Studio

    1. In Solution Explorer, right-click your project → Add → Reference…

    2. Select Browse → navigate to: .\libs\AIS_SDK\AVEVA.IntegrationService.DataAPI.SDK.Lib.dll

    3. Select Add → OK

  4. Ensure the DLL is deployed with your application

    1. In Solution Explorer, expand References

    2. Select AVEVA.IntegrationService.DataAPI.SDK.Lib

    3. In the Properties window, set Copy Local = True

      This ensures the DLL is copied to your output folder during build/publish.

  5. Build and validate

    1. Rebuild the solution.

    2. Confirm the DLL exists in your output folder after build (example): .\bin\Debug\ or .\bin\Release\

Troubleshooting

  • Broken reference after sharing the project: This usually happens if the DLL is referenced from a user-specific path (e.g., Downloads). Always place the DLL in a solution-local folder like .\libs\AIS_SDK\.

  • Version mismatch: If you see runtime/compatibility issues, verify the DLL version matches the installed AIS version.

  • Do not install via NuGet: This SDK is provided via Product Support deliverables and must be referenced as a DLL.

Configuration

AIS Data API is available in two deployment flavors, and the SDK can be used by selecting the appropriate host and authentication type:

  • AIS Local (fully on‑premises): https://{aisServer}:60930/api/v1.2/

  • AIS Cloud (hybrid deployment): https://eu.ais.connect.aveva.com/data/api/v1.2/

The AIS Data API is versioned. Versions v1.0 and v1.1 remain operational, however v1.2 is recommended. The SDK is intended to be used with the current AIS Data API version (v1.2).

Authentication and authorization

  1. AIS Local (on‑premises) — NTLM + IIS authorization

    • Authentication: Windows Integrated Authentication (NTLM).

    • Authorization: enforced via IIS URL Authorization rules.

      • The calling Windows user/service account must be granted access in IIS (per the site/application authorization configuration) to successfully call the AIS Data API.

        1. AIS Cloud (CONNECT) — Bearer token + CONNECT roles

      • Authentication: Bearer token (CONNECT).

      • Users must obtain a token from CONNECT before calling the API. Supported approaches include:

        • Access Token (user context)

        • Service Application (service-to-service / app context), depending on integration needs.

      • Authorization: controlled by CONNECT roles/permissions.

        • The CONNECT user or service application must be granted the appropriate roles to use the AIS Data API and perform the required operations.

      Using the SDK (selection guidance)

      When configuring the SDK, choose based on your deployment:

      • Host/Base URL: select AIS Local or AIS Cloud endpoint as applicable.

      • Auth type: select NTLM for AIS Local, or CONNECT for AIS Cloud.

      • API version: use v1.2 unless instructed otherwise for backward compatibility

      Minimal Configuration

      At minimum, you need to provide the DataAPI host URL:

      string host = "https://your-ais-server/api/v1/datasources";

      App.config (Console / .NET Framework)

      <?xml version="1.0" encoding="utf-8" ?>

      <configuration>

      <appSettings>

      <add key="host" value="https://your-ais-server/api/v1/datasources"/>

      <add key="AuthenticationType" value="NTLM"/>

      <add key="waitingTimeInMinutesForLiveData" value="60"/>

      </appSettings>

      </configuration>

      appsettings.json (.NET 5+)

      {

      "DataApi": {

      "Host": "https://your-ais-server/api/v1/datasources",

      "AuthenticationType": "NTLM",

      "TimeoutMinutes": 60

      }

      }

      To learn more about the configuration options, refer to Configuration.

      In This Topic