1. Get Started
ACal API(en-US)
  • Get Started
    • Quickstart
    • Integration Solutions
  • API Functions
    • Accounts
      • README
      • Login (Auth)
      • Logout
    • DUT
      • Others
        • Query DUT count by condition
        • Query DUT information by condition
        • Get DUT information by ID
        • Batch save DUT info that shares the same template but differs only by ID
      • Batch save or update DUT information
      • Delete DUT
    • Test Records
      • README
      • Query Key-Value Data
        • Key-Value Data Response Message Specification
        • Query Record Dictionary Data by Condition
        • Get Record Dictionary Data by ID
        • Query Unsynced Record Dictionary Data
      • Export Certificate Excel File
        • Export Certificate as Excel by Condition
        • Export Certificate as Excel by ID
        • Export Certificate as Excel by Template
      • Export Certificate PDF File
        • Export Certificate as PDF by Condition
        • Export Certificate as PDF by ID
        • Export Certificate as PDF by Template
      • Query Structured Data
        • Query Record Structured Data by Condition
        • Get Record Structured Data by ID
        • Query Unsynced Record Structured Data
      • Others
        • Data Sync Status
          • Query Unsynced Record Count
          • Update Record Sync Status
        • Query Record Header Structured Data by Condition
        • Query Same Calibration-Task Record Dictionary Data by Condition
        • Delete Record
      • Query Record Count by Condition
    • Others
      • References
        • Query DUTs that meet the condition
        • Get DUT by ID
        • Query count of DUTs that meet the condition
        • Query device types of standard instruments
        • Save or update DUT information
        • Delete DUT information
      • Templates
        • Get user template list for the specified DUT type
      • Reports
        • Query record report data by condition
        • Export record report CSV by condition
        • Query count of record report data by condition
  • Releases
    • Changelog
  1. Get Started

Quickstart

1. Interface Overview#

1.1 Purpose#

This API specification is designed to meet the needs of customer business systems to read test data from, and write instrument information and other business data to, the ACal verification/calibration system software.

1.2 Audience#

The intended audience of this document is software developers working on metrology business systems.

1.3 Scope#

This API specification applies to both ACal Network Edition and ACal Professional Edition software.
ℹ️ Recommendation: When more than one computer uses ACal software, it is recommended to perform a one-time center-to-center integration with the central database of ACal Network Edition.

1.4 Interface Protocol#

The customer interface uses the HTTP POST communication protocol. Almost any client and any programming language can be used to interact with the ACal customer interface.

1.5 Encoding Standard#

Encoding uniformly uses UTF-8.

1.6 Message Format#

JSON format is used uniformly.

2. Preparations#

2.1 Install ACal Software#

Before deploying the API service, please install the ACal software first. If you are using ACal Network Edition, please install both "ACal Server Management Software" and "ACal Verification/Calibration System Software" on the server.
If you do not have the official version, you can open the following link to obtain the Professional Edition trial installation package: (Internal Beta Version)
If the version is too low (1.5.260919 or above), please download and install the latest software upgrade package: (Internal Beta Version)
How to check the software version: the status bar at the bottom-right of the client's main interface.

2.2 Install the API Service#

By default, the software does not enable the API service; the user needs to install it manually.
Operation method: Run APIServiceManager.exe in the ACal software installation directory. A login window will appear; enter the password "api" to enter the main interface.
The software configuration displays the installed ACal software version, installation location, database location, and database name on this machine. The user clicks the "Install" and "Start " buttons in sequence to complete the service deployment.
Note: After the service is installed, it will start automatically on every system startup; manual startup is no longer required each time.
Note: If the API service program cannot run on an operating system earlier than Windows 8, please download and install .NET Framework 4.5.1 or later first.
API Testing:
Click the "Test" button to automatically open Swagger in the browser.

2.3 Typical Integration Flow#

Process Description:
Enter the business platform's "Task/Plan Management" module, select the task to be tested, and click the "Download" button to call the ACal API and dispatch instrument information.
Enter the ACal calibration interface, select the instrument to be tested, perform the test, and generate test results.
Enter the business platform's "Task/Plan Management" module, click the "Collect Data" button to call the ACal API and retrieve test data.
After the system integration is completed, certificate generation and management are handled by the business platform. Therefore, when developing the test data integration, you typically only need to focus on the "API Functions/Test Records".

2.4 Selecting the Test Data Interface#

Before developing the test data interface, please select the appropriate interface based on the characteristics of your business system:
No.Data TypeApplicable Business SystemDescription
1Dictionary dataProvides online certificate generation; when generating a certificate, first select an Excel-like form template, then enter the test data.
2Excel fileSupports uploading offline certificate files

3. API Debugging#

This API documentation is only intended to help business platform developers quickly understand the capabilities of the ACal API and the integration design.
Download the Apifox API debugging tool, log in with the user given below and enter the ACal API project to quickly debug interfaces and access more API test cases.
Apifox API debugging tool download URL:
Username:
Password:

4. API Authentication#

See Accounts/README for details.
Modified at 2026-10-29 09:13:07
Next
Integration Solutions
Built with