ATSCADA IWebAPI Tools – Web API Integration Tools for Modern SCADA Systems

The ATSCADA IWebAPI toolset is designed to retrieve data from ATDriver Server and expose it through APIs, allowing external systems to access and use the data flexibly and efficiently, while supporting file exchange through ATSCADA iFtp.

System Preparation and Installation

Step 1: Install the iWebAPITools Package

  1. Open the Resources Installation Manager software.
  2. Find iWebAPITools (Version 5.0.0.1).
  3. Click the Install button.
  4. When the setup window appears, click InstallFinish to complete the installation of ATSCADA IWebAPI.

Resources Installation Manager Professional interface listing ATSCADA software modules with iWebAPITool highlighted for installation.

Step 2: Configure ATDriver Server (Create Data Tags)

This is a very important step to create the data source for calculation tools in ATSCADA IWebAPI.

Open ATDriver Server. Go to FileNew.
Add Channel: Name APITool, Driver select InternalMemory.all.dll.
Add Device: Name Device 1.
Create the following Tags (Data Type: String/Double):

  • Tag1
  • Tag2
  • Tag3

Go to FileSave As and save the file as APITools.xml.

ATDriver Server software interface displaying APITools Device1 with Tag1, Tag2, and Tag3 data points in the monitoring table.

Step 3: Configure iTagBuilder

Open iTagBuilder. Select NewYes.

At Driver Name, enter ATDriver. Click Add Driver, then select ATDriverClient.dll.

Enter the IP Address of the computer running Driver Server (for example: 192.168.1.122) or keep the default localhost. Click Connect.

Go to ToolsImport All. Select the Device and click OK.

Go to FileProject Register, save the file name, and click Yes to register tags into the ATSCADA IWebAPI system.

ATSCADA Tag Builder software interface showing APIToolsDevice1 with Tag1, Tag2, and Tag3 configured for API data communication.

Interface Design in Visual Studio

Step 4: Integrate iWebAPITools into Toolbox

Open Visual Studio and create a Windows Forms App (.NET Framework) project.

On the Toolbox panel, right-click and select Add Tab, then name it ATSCADA iWebAPITools.

Right-click the newly created tab and select Choose Items…

Click Browse, then navigate to the installation path:

C:\Program Files\ATPro\ATSCADA\iWebAPITools\iWebAPITools.dll

Click OK. The tool icons of ATSCADA IWebAPI will appear in the Toolbox.

Add Reference

  1. In the Solution Explorer window, right-click References → Select Add Reference…
  2. Click Browse and navigate to the ATSCADA installation folder: C:\Program Files\ATPro\ATSCADA
  3. Select the file Microsoft.Owin.Host.HttpListener.dll → Click Add → Click OK for ATSCADA IWebAPI integration.
view atscada demo & download
whatapp

Detailed Guide to ATSCADA IWebAPI Tools

Important Note: Always drag the iDriver tool onto the Form before using any other tools.

iWebAPI Tool

  • Description: Drag iWebAPI onto the Form.
  • Configuration Properties:
    • Driver: Select iDriver1.
    • Host: Enter the IP address of the running computer (for example: 192.168.1.122 or localhost).
    • Port: Set the port (for example: 8000 or 9000).
    • Username: Set the login username (for example: admin).
    • Password: Set the login password (for example: 123456).

iWebAPI1 property panel showing ATSCADA Settings with database connection parameters including driver, host, port, username, and password.

  • Test API with Postman:

Postman is a professional tool used to test API endpoints, including functions such as GET, POST, and more for ATSCADA IWebAPI.

Open Postman, then on the main interface select New.

Dark user interface header displaying History section with New and Import buttons.

Select HTTP

On the right interface, select the POST method and enter the API endpoint address based on the configuration previously set in iWebAPI: 192.168.1.122:9001/api/atscada/login.

Then switch to the Body tab, select raw, and choose JSON format.

After selecting these options, you will get the result as shown in the image below.

In the section below, enter the JSON file structure as illustrated for ATSCADA IWebAPI.

API testing interface sending POST request to ATSCADA login endpoint with JSON body containing username and password credentials.

Sample JSON:

{
“Username”: “admin”,
“Password”: “123123”
}

Click Send to call the configured API endpoint. If successful, a token string will be returned in the Body tab below for ATSCADA IWebAPI.

API client interface showing successful ATSCADA login POST request response with status 200 OK and returned authentication token in JSON format.

This Token string is used to authenticate users when calling the API.

After obtaining the Token, we will test the GET method to retrieve registered values from ATDriver Server using ATSCADA IWebAPI.

Change the method from POST to GET and update the API syntax as follows:

192.168.1.122:9001/api/atscada

Then switch to the Authorization tab. Select Bearer Token as the Type, and paste the Token string obtained in the previous step into the Token field.

API testing interface configured with Bearer Token authorization for ATSCADA GET request endpoint.

Then click Send to call the API endpoint. If successful, you will receive all data of the TagName values previously configured in ATDriver Server through ATSCADA IWebAPI, which can be used for AI time series forecasting.

API client interface showing successful ATSCADA GET request with Bearer Token authorization and JSON data response containing tag values and status..

👉 Learn More about SCADA Software

ATPro việt nam

ATSCADA - Smart SCADA Software with AI Predictor & Blockchain. ATSCADA is an advanced SCADA software platform for real-time monitoring, intelligent control, and efficient data acquisition. It is ideal for Industrial IoT (IIoT), smart cities, integrated automation systems, and Agriculture 4.0. With a built-in AI Predictor, ATSCADA enables predictive analytics to detect issues early, optimize performance, and reduce downtime. The integration of Blockchain technology ensures secure, transparent, and tamper-proof data management. Highly scalable and easy to integrate, ATSCADA is trusted by businesses to enhance productivity, strengthen cybersecurity, and accelerate digital transformation.

Related articles

Common ATSCADA Errors and How to Fix Them – FAQ for ATSCADA Tools and Systems

Issues Related to ATDriverServer & iTagBuilder Software Why Does ATDriverServer Not Open? There are two [...]

ATSCADA Hospital Temperature and Humidity Monitoring Alarm System Project

Requirements: The system includes three monitoring areas: the pharmacy, inpatient warehouse, and cold storage, following [...]

ATSCADA CookBook: Complete Guide to System Architecture, Tools, Installation & Troubleshooting

The ATSCADA Training book is an essential navigation structure that helps users access all major [...]

ATSCADA Power Management System

Requirements: There are 3 areas that require power management, including a factory, a residential zone, [...]

ATSCADA Project Deployment Guide: Create and Run Projects on Another Computer

ATSCADA Project Deployment is an essential process for transferring a completed SCADA project from the [...]

How to Create a New Custom Component for Windows Forms Applications

Purpose of the Component This ATSCADA Custom Component is designed to automatically accumulate values from [...]

T.Vấn Zalo(t.Việt)
ATSCADA Profile.
WhatsApp ( Eng.)
Map (chỉ đường.)