1. Authentication Mode Configuration#
ACal can be configured with two identity authentication modes:No-Authentication Mode: Call a specific API interface directly without verifying the identity of the caller.
Authentication Mode: Before accessing a business interface for the first time, you must log in using an ACal account and password to verify your identity.
Operation method: Run APIServiceManager.exe in the ACal software installation directory and click the "Config" button.The API service disables authentication mode by default. To enable it, follow the steps shown below:2. Authentication Mode#
Before accessing a business interface for the first time, you must log in using the ACal software account and password to verify your identity. Upon successful authentication, an ApiKey is returned with a timeout of 20 minutes.| Request URL | http://127.0.0.1:8600/ACal/AccountService/Login |
|---|
| Request Body | |
| Response | { "StatusCode": 0, "AccountID":"admin", "AccountName":"Administrator", "ApiKey": "7db82f63-ef7a-4c7c-81b5-1bf4698b3701" } |
| Description | 1. If authentication succeeds, StatusCode is 0 and an ApiKey is returned. 2. If authentication fails, StatusCode is 101 (invalid account) or 102 (incorrect account or password). |
When calling a business interface, you must add an ApiKey property to the request Header. This verifies both the logged-in identity and whether the user has access permission for the interface. Access permission depends on the operation permissions of the logged-in account.| Request URL | http://127.0.0.1:8600/ACal/xxx/xxx |
|---|
| Request Header | ApiKey=7db82f63-ef7a-4c7c-81b5-1bf4698b3701 |
| Request Body | Ignored |
| Response | { "StatusCode": 0, …… } |
| Description | If the ApiKey is invalid or expired, StatusCode = 2 |
To authenticate in Swagger:1.
Click the "Authorize" button.
2.
In the popup value text box, enter the ApiKey returned by calling the Login interface.
3.
Click the "Authorize" button in the popup.
After the interface operations are finished, call the Logout interface to end the session.Modified at 2026-09-04 12:15:23