- Parking Software LAN Interface
- Documentation
- 1. Introduction
- 2. Categories
- 3. V2.0 Interface Documentation (HTTP)
- 3.1 Development Guide
- 3.1.1 Parameter Acquisition and Configuration
- 3.1.2 Basic Rules
- Basic Information
- Character Set
- Field Naming Rules
- Request Unique Identifier
- Date Format
- Parameter Format
- 3.1.3 Interface Authentication
- Overview
- Signature Generation Steps
- Example
- Step 1 – normalise
Data - Step 2 – build the pre-sign string
- Step 3 – sign
- Remarks
- Code Samples
- HMAC-SHA256 helper (C#)
- 3.1.4 Type Enumeration List
- 3.1.5 Sensitive Information Decryption
- 3.1.6 Callback Configuration Instructions
- 4. Query Interfaces(V2.0)
- Query Zone Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Booth Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Lane Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Plate Type Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Plate Color Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Lane Ground Loop Barrier Status
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Lane Current Order
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Vehicle Record
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Blacklist Records
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Parking Order Records
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Payment Records
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Payment Detail Records
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Gate Release Record
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Coupon Scheme
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Plate Coupon Records
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Query Parking Fee for Specified Order
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Request Example
- Return Parameter Description
- Return Example
- 5. Notification Interfaces(V2.0)
- In-Parking Record Change Notification (Including Modify and Close)
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Vehicle Changes (Including Add, Edit, Delete)
- Brief Description
- Note
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Blacklist Changes (Including Add, Edit, Delete)
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Plate Coupon Record Changes (Including Add, Edit, Delete)
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Coupon Scheme Changes (Including Add, Edit, Delete)
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Query Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Control Lane Barrier Status (Including Release, Close,Normally Release,Cancel Normally Release)
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Lane Popup Order Fee Modification
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Vehicle Payment Information
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Create Entry Order for Vehicle Without Plate
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Callback Parameter Changes
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- Notify Failed Callback Business Retry
- Brief Description
- Request URL
- Request Method
- Request Content-Type
- Request Parameters
- Body Parameters
- Request Example
- Return Parameter Description
- Return Example
- 6. Callback Interfaces(V2.0&V3.0)
- Vehicle Entry Callback
- Brief Description
- Example URL
- Request Method
- Request Content-Type
- Callback Parameter Description
- Request Example
- Return Parameter Description
- Return Example
- Vehicle Exit Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Payment Result Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Vehicle Issuance Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Vehicle Cancellation Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Vehicle Recharge and Extension Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Gate Release Record Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Parking Space Change Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Blacklist Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- Booth Lane Information Callback
- Brief Description
- Example URL
- Request Method
- Content Type
- Callback Parameter Description
- Callback Parameter Example
- Callback Return Description
- Return Example
- 7. V3.0 Interface Documentation (MQTT)
- 7.1 Development Guide
- 7.1.1 Parameter Acquisition and Configuration
- 7.1.2 Basic Rules
- 7.1.3 Interface Authentication
- 7.1.4 Type Enumeration List
- 7.1.5 Sensitive Information Decryption
- 7.1.6 Callback Configuration Instructions
- 7.2 Interface Route & Difference Table
Parking Software LAN Interface
Documentation
This document includes an introduction to the LAN interface, classification and prerequisites for using the LAN interface, and explanations of the corresponding interface documentation for the LAN interface.
1. Introduction
The LAN interface is designed for third-party integration scenarios where parking lot-related data is not intended to be uploaded to the platform, but there is a need to perform related data queries, additions, modifications, and receive entry/exit data from the software side within the local area network.
The LAN interface is divided into three categories: Query, Notification, and Callback.
- Query : Refers to requesting relevant data from the software side via the interface, such as querying records of vehicles in the lot or payment records.
- Notification: Refers to sending relevant data to the software via the interface, after which the software saves the data, such as adding a license plate or controlling the gate to open.
- Callback: Refers to the software uploading relevant data to the integrator’s server, where the integrator is responsible for saving this type of data, such as uploading available parking spaces, entry information, or exit information.
2. Categories
The LAN interface is divided into two versions: V2.0 and V3.0:
- V2.0 interface: This version offers a more comprehensive set of functional interfaces and provides greater convenience for interface invocation.
- V3.0 interface: This version utilizes the MQTT protocol for integration, effectively overcoming network access restrictions and ensuring real-time and reliable data interaction.
3. V2.0 Interface Documentation (HTTP)
This service is the LAN interface designed for third-party developers.By calling the API interfaces we provide, developers can integrate the following functions into their own applications or services:querying information related to local parking lot operations, parking payment, vehicle registration, Gate Release Record, and other features.
3.1 Development Guide
This document primarily covers the acquisition of parameters and software-side configurations during integration, as well as basic rules and related type enumerations (payment methods, license plate colors, callback interfaces, payment scenarios, order statuses, query operators, etc.). It also includes interface signature methods, handling of sensitive information, callback configuration instructions, and more.
3.1.1 Parameter Acquisition and Configuration
Calling the API requires the use of the appid, AppSecret and ParkKey parameters. These must be configured and filled in within the System Settings. The specific steps are shown below:

3.1.2 Basic Rules
Basic Information
All API requests must use HTTP.
Character Set
Interfaces use the UTF-8 character encoding.
Field Naming Rules
All parameter fields related to the interface adopt Pascal Case naming convention. Similar to Camel Case but with the first letter capitalized, e.g., FirstName, LastName, UserName.
Request Unique Identifier
The parking lot’s local open interface assigns a unique identifier to each received request. This unique identifier is included in the response’s ResultId. When assistance with parking lot interface development is needed, please provide the request’s unique identifier and relevant parking lot logs to help us locate the specific request more quickly.
Date Format
All date objects follow the format examples defined below:
yyyy-MM-dd HH:mm:ss
yyyy-MM-dd HH:mm:ss:fff
yyyy-MM-ddParameter Format
Interface request parameter type uses Content-Type=application/json.
3.1.3 Interface Authentication
Overview
- This document provides a detailed description of the signature-logic implementation for open-interface requests to the parking-lot system.
- The logic covers request-parameter processing, sorting, and HMAC-SHA256 signing.
Signature Generation Steps
Prepare data
- Collect the items that will take part in the signature:
AppId,ParkKey,TimeStamp,Nonce,Data.
- Collect the items that will take part in the signature:
Process
Data- Sort every key/value pair in
Databy ASCII code (ascending). - Concatenate the pairs with “&” and convert the whole string to lower-case.
- Compute the MD5 hash of the resulting string (32-char hex, UTF-8).
Rules
- If
Datais an array or collection, convert it to a list, process each element individually, then join the results with “&”. - If
Datais a single object, sort its fields directly. - When
Dataisnull, still include it in the signature asData=(empty value).
Any other parameter whose value isnullis omitted from the signature string.
- Sort every key/value pair in
Build the signature string
- Concatenate the following five items in exact order, separated by “&”:
AppId,Data(already hashed),ParkKey,TimeStamp,Nonce.
- Concatenate the following five items in exact order, separated by “&”:
Sign
- Convert the entire concatenated string to lower-case.
- Compute HMAC-SHA256 using
AppSecretas the key. - Encode the digest as Base64 and convert it to lower-case.
- The result is the final signature value.
Example
Given the request body:
{
"ParkKey": "1702399313365243",
"AppId": "fkqju0n1",
"TimeStamp": "1704527859009",
"Nonce": "928885",
"Sign": "x1aeqmo3/hs9cbhlbnzburgskf1gvd/lil2t/iasiyo=",
"Data": [
{ "Index": 1, "Url": "http://aebhfqld.gt/tgmjt " },
{ "Index": 3, "Url": "http://qtdupkzq.sd/dsicxsc " },
{ "Url": "http://dfxkmte.tv/mpeop ", "Index": 2 },
{ "Url": "http://hdphhisif.ni/uejufkem ", "Index": 4 }
]
}Step 1 – normalise Data
Sort all key/value pairs by key (ASCII ascending):
Index=1&Url=http://aebhfqld.gt/tgmjt&Index=2&Url=http://dfxkmte.tv/mpeop&Index=3&Url=http://qtdupkzq.sd/dsicxsc&Index=4&Url=http://hdphhisif.ni/uejufkemLower-case the string and compute MD5 → assume the digest ismd5Result = 5d41402abc4b2a76b9719d911017c592
Step 2 – build the pre-sign string
AppId=fkqju0n1&Data=5d41402abc4b2a76b9719d911017c592&ParkKey=1702399313365243&TimeStamp=1704527859009&Nonce=928885Step 3 – sign
- Lower-case the entire string and run HMAC-SHA256 with
AppSecret. - Base64-encode the digest and lower-case it → the value must match the
Signfield in the request.
Remarks
- Every key/value pair must be sorted by ASCII code.
- The HMAC key is always
AppSecret. TimeStampmust be a 13-digit Unix timestamp (milliseconds).Noncemust be a random string to prevent replay attacks.- When
Dataisnull, still includeData=in the signature string; all othernullfields are skipped. - In callback interfaces, some image Base64 fields are not included in signature calculation. The specific field remarks shall prevail.
Code Samples
HMAC-SHA256 helper (C#)
/// <summary>
/// HMAC-SHA256 signature
/// </summary>
/// <param name="data">data to be signed</param>
/// <param name="secret">secret key</param>
/// <returns>signed data, base64 encoded, converted to lower-case</returns>
public static string HmacSha256Sign(string data, string secret)
{
try
{
var encoding = new UTF8Encoding();
var keyByte = encoding.GetBytes(secret);
var messageBytes = encoding.GetBytes(data);
using var hmacsha256 = new System.Security.Cryptography.HMACSHA256(keyByte);
var hashmessage = hmacsha256.ComputeHash(messageBytes);
var result = Convert.ToBase64String(hashmessage);
return result.ToLower();
}
catch (Exception ex)
{
OpenApiLog.WriteLog("HMAC-SHA256 signature exception", ex);
return string.Empty;
}
}#####Convert Data to sorted string (C#)
/// <summary>
/// Sort Data by ASCII code (ascending) and convert to string
/// </summary>
/// <param name="data">request data</param>
/// <returns>converted string</returns>
private static string ConvertDataToString(object data)
{
// if data is null, return empty string
if (data == null)
{
return string.Empty;
}
// if data is array or collection
if (data.GetType().IsArray || data is IEnumerable<object>)
{
// convert array to list
var dataList = ((IEnumerable<object>)data).ToList();
// process each element in the list recursively
var dataDictList = dataList.Select(ConvertDataToString);
// use stable sort to ensure identical elements do not swap positions
dataDictList = dataDictList.OrderBy(p => p, StringComparer.Ordinal).ToList();
// convert each element to string and join with "&"
return string.Join("&", dataDictList);
}
// if data is object
// use reflection to get property values and convert to key-value pair sequence
var dataDict = data.GetType().GetProperties()
.Select(p =>
{
// get property value
var value = p.GetValue(data);
// if property value is array, process recursively
if (value != null && (value.GetType().IsArray || value is IEnumerable<object>))
{
value = ConvertDataToString(value);
}
// return key-value pair
return new KeyValuePair<string, object>(p.Name, value);
})
// filter out key-value pairs whose value is null
.Where(p => p.Value != null)
// use stable sort on key-value pair sequence
.OrderBy(p => p.Key, StringComparer.Ordinal)
// convert key-value pair sequence to dictionary
.ToDictionary(p => p.Key, p => p.Value);
// convert dictionary to string and join with "&"
return string.Join("&", dataDict.Select(p => $"{p.Key}={p.Value}"));
}3.1.4 Type Enumeration List
LicensePlateColorEnum
| No. | License Plate Color |
|---|---|
| 0 | Unknown |
| 1 | Blue |
| 2 | Yellow |
| 3 | White |
| 4 | Black |
| 5 | Green |
| 6 | Yellow-Green |
PaymentMethodEnum
| Payment Method Code | Payment Method Name |
|---|---|
| 79001 | Offline Cash Payment |
| 79002 | Platform Cash Payment |
| 79003 | WeChat Pay |
| 79004 | Android App Payment |
| 79006 | Terminal Device Payment |
| 79007 | Alipay |
| 79009 | Third-Party Payment |
| 79010 | Offline WeChat Pay |
| 79011 | Offline Alipay |
| 79014 | CCB Payment |
| 79015 | CMB One-Net Payment |
| 79016 | UnionPay Express Payment |
| 79017 | CCB Express Payment |
| 79012 | Alipay Express Payment |
| 79013 | WeChat Express Payment |
| 79018 | WeFuTong Aggregate Pay |
| 79019 | CMB Express Payment |
| 79020 | ICBC Express Payment |
| 79021 | ICBC Payment |
| 79022 | ABC Express Payment |
| 79023 | ABC Payment |
| 79024 | ETC Payment |
| 79025 | BOC Payment |
| 79026 | BOC Express Payment |
| 79027 | LeJuHe Payment |
| 79028 | UnionPay Business |
| 80002 | Self-Service Cash Payment |
| 79029 | Charging Deduction |
| 79039 | Suixingfu |
CallbackInterfaceEnum
| No. | Callback Interface Description | Supports Failure Retry |
|---|---|---|
| 0 | Vehicle Entry Callback | Yes |
| 1 | Vehicle Exit Callback | Yes |
| 2 | Payment Result Callback | Yes |
| 3 | Monthly Card Issuance Callback | Yes |
| 4 | Monthly Card Recharge/Extend Callback | Yes |
| 5 | Monthly Card Cancellation Callback | Yes |
| 6 | Parking Space Change Callback | No (latest data only) |
| 7 | Abnormal Exit Record Callback | Yes |
| 8 | Blacklist Info Callback | Yes |
| 9 | Violation Reservation Callback | Yes |
| 10 | Booth Lane Info Callback | No (query manually) |
RequestResultCodeEnum
| Result Code | Description |
|---|---|
| 200 | Operation successful |
| 1001 | Signature verification failed |
| 1002 | Invalid request parameters |
| 1003 | Interface service processing exception, please contact administrator |
| 1004 | Interface service not enabled |
| 1005 | Expected error, refer to actual error message returned |
PaymentScenarioEnum
| Payment Scenario Code | Payment Scenario Description |
|---|---|
| 0 | Other |
| 1 | In-Park QR Payment |
| 2 | Lane QR Payment |
QueryOperatorEnum
| Enum | Value | Description |
|---|---|---|
| Equal | 0 | Equal to |
| Like | 1 | Fuzzy query |
| GreaterThan | 2 | Greater than |
| GreaterThanOrEqual | 3 | Greater than or equal to |
| LessThan | 4 | Less than |
| LessThanOrEqual | 5 | Less than or equal to |
| In | 6 | In operation Correct format: X, Y, ZWrong format: 'X', 'Y', 'Z' |
| NotIn | 7 | Not in operation; parameters same as In |
| LikeLeft | 8 | Left fuzzy |
| LikeRight | 9 | Right fuzzy |
| NoEqual | 10 | Not equal |
| IsNullOrEmpty | 11 | Is null or '' |
| IsNot | 12 | Case 1: Value ≠ null → field = xCase 2: Value = null → field is null |
| NoLike | 13 | Negation of fuzzy query |
| EqualNull | 14 | Case 1: Value ≠ null → field = xCase 2: Value = null → field is null |
| InLike | 15 | Correct format: X, Y, ZWrong format: 'X', 'Y', 'Z'Generated SQL: id like '%X%' or id like '%Y%' or id like '%Z%' |
Field Notice
Fields inside arrays returned by query-data interfaces do not support conditional filtering!
Operator Notes
MySQL field types and the operators they support:
1. Numeric Types
- Integer (
INT,BIGINT,TINYINT, etc.)
Operators:=,<>,>,<,>=,<=,IN,NOT IN - Floating-point (
FLOAT,DOUBLE)
Operators:=,<>,>,<,>=,<=,IN,NOT IN
2. Character Types
CHAR,VARCHAR
Operators:=,<>,LIKE,NOT LIKE,IN,NOT INTEXT
Operators:=,<>,LIKE,NOT LIKE,IN,NOT IN
3. Date & Time Types
DATE
Operators:=,<>,>,<,>=,<=,IN,NOT INTIME
Operators:=,<>,>,<,>=,<=,IN,NOT INDATETIME,TIMESTAMP
Operators:=,<>,>,<,>=,<=,IN,NOT IN
4. Boolean Type
BOOLEAN
Operators:=,<>,IN,NOT IN
OrderStatusEnum
| Order Status Code | Order Status Description |
|---|---|
| 199 | Pre-Entry |
| 200 | Entered |
| 201 | Exited |
| 202 | Auto Closed |
ManualGateOperationTypeEnum
| Manual Gate Operation Type Code | Manual Gate Operation Type Description |
|---|---|
| 0 | Exit opened without entry record |
| 1 | Manual open |
| 2 | Special plate number |
| 3 | Manual close |
| 4 | Barrier kept open / cancel keep-open |
| 6 | Illegal open |
AbnormalPassageTypeEnum
| Abnormal Passage Type Code | Abnormal Passage Type Description |
|---|---|
| 6100 | Auto release without entry record |
| 6201 | Manual open |
| 6202 | Manual close |
| 6211 | Barrier kept open |
| 6212 | Cancel keep-open |
3.1.5 Sensitive Information Decryption
Description
When sensitive information is returned by a query, it is encrypted and must be decrypted.
How to Tell if a Field Needs Decryption
Encrypted fields are usually returned in Base64 format and are marked “requires decryption” in the field description.
Decryption Method
Data is encrypted/decrypted with AES. Key details are in the table below:
| Item | Description |
|---|---|
| Key (UTF-8) | infoexchange4api |
| IV (UTF-8) | activevector4api |
| Encoding | Base64 |
| Key size | 128-bit |
| Mode | CBC |
| Padding | Pkcs7 / Pkcs5 |
Sample CodeC# example
/// <summary>
/// Decrypts a value using the AES algorithm.
/// </summary>
/// <param name="value">Encrypted value to decrypt.</param>
/// <param name="key">Encryption key.</param>
/// <param name="iv">Initialization vector.</param>
/// <returns>Decrypted value as a string.</returns>
public static string AesDecrypt(string value, string key, string iv)
{
// Return input as-is if null or empty
if (string.IsNullOrEmpty(value)) return value;
// Validate key
if (key == null) throw new Exception("Encryption key not set.");
if (key.Length < 16) throw new Exception("Key length must be at least 16 characters.");
if (key.Length > 32) throw new Exception("Key length must not exceed 32 characters.");
if (key.Length != 16 && key.Length != 24 && key.Length != 32)
throw new Exception("Key length is ambiguous.");
// Validate IV length if provided
if (!string.IsNullOrEmpty(iv) && iv.Length < 16)
throw new Exception("IV length must be at least 16 characters.");
// Convert key to byte array
var keyBytes = Encoding.UTF8.GetBytes(key);
// Convert Base64-encoded cipher text to byte array
var encryptedBytes = Convert.FromBase64String(value);
// Create RijndaelManaged instance
using (var aes = new RijndaelManaged())
{
// Set IV: use provided value or first 16 bytes of key
aes.IV = !string.IsNullOrEmpty(iv) ? Encoding.UTF8.GetBytes(iv) : keyBytes.Take(16).ToArray();
// Set encryption key
aes.Key = keyBytes;
// Set cipher mode to CBC
aes.Mode = CipherMode.CBC;
// Set padding mode to PKCS7
aes.Padding = PaddingMode.PKCS7;
// Create decryptor
var cryptoTransform = aes.CreateDecryptor();
// Transform cipher text back to original bytes
var resultArray = cryptoTransform.TransformFinalBlock(encryptedBytes, 0, encryptedBytes.Length);
// Convert result bytes to UTF-8 string
return Encoding.UTF8.GetString(resultArray);
}
}3.1.6 Callback Configuration Instructions
1. When is a callback service required?
When integrating third-party parking services, if you need the parking system to notify you of vehicle entry/exit, payment details, monthly ticket registration, monthly ticket extensions, monthly ticket cancellations, or parking space updates by area, you must configure a callback service.
2. How to configure the callback service
During integration, the developer must call the local parking service’s “Set Callback Parameters” API to enable the required callback interfaces. If no parameters are set, no callbacks will be triggered by default.
3. What functions must the callback service implement?
The callback service must expose the APIs described in the callback interface documentation and return data in the specified format. To ensure data integrity, signature verification is recommended.
4. Callback service limitations
If the parking system fails to deliver a callback notification, it will retry at most 3 times and then stop to avoid infinite loops.
To recover missing data, call the “Re-pull Failed Callbacks” API manually.
Note: Developers must handle any business-level exceptions themselves. Once a callback has failed, repeating it is meaningless. Log the details and respond to the parking service with “processed” to terminate the retry cycle.
5. Signature-verification tips for callbacks
Some callback fields contain boolean, float, or integer values.
Do not convert them arbitrarily (e.g., amount 0.00 must remain 0.00, not 0), or the signature check will fail.
4. Query Interfaces(V2.0)
Query Zone Information
Brief Description
- This API is used to query zone information.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | Area | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774578368997",
"Nonce": "nfmpg55zpdg5",
"Sign": "rqvchzlkui1kws1jtinrltypgohs7idy6yp8tmfmcqy="
}Return Parameter Description
| Parameter | Type | Parameter Name | Required | Description | Remarks |
|---|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For detailed information, please refer to the type enumeration/result code enumeration. 200 indicates successful operation by default. | |
| ResultMsg | string | true | Request message | The information prompt returned by the API request. | |
| ResultId | string | true | Request response identifier | An identifier for this specific processing response. | |
| Data | object | null | false | Specific data | The data object corresponding to the API response. | |
| » PageIndex | integer | true | Current page number | The current page number, starting from 1 for easier comprehension. | |
| » PageSize | integer | true | Page size | The number of items per page. | |
| » TotalCount | integer | true | Total data count | The total number of data items. | |
| » Results | [object] | null | false | Current query data results | The results of the current data query. | |
| »» Uid | integer | true | Unique primary key of the record | The unique primary key of the current record. | |
| »» No | string | true | Record number | The unique number representing the current record. | |
| »» AreaName | string | true | Area name | The name of the area. | |
| »» AreaType | integer | true | Area type | Area type, 0 - Outer field, 1 - Nested inner field. | |
| »» AreaSpaceNum | integer | true | Number of available parking spaces in the area | The count of available parking spaces in the area. | |
| »» PUid | integer | true | Parent area primary key when nested | When the area is nested, this is the primary key of the associated parent area. For outer field areas, this value is 0. | |
| »» Level | integer | true | Current nesting level of the area | The nesting level, indicating which layer the area belongs to. 0 indicates the outermost outer field area. | |
| »» CreationTime | string | true | Creation time | The timestamp when the data was created. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 1,
"No": "1772492942540835",
"AreaName": "Outer Field",
"AreaType": 0,
"AreaSpaceNum": 500,
"PUid": 0,
"Level": 0,
"CreationTime": "2026-03-18 02:32:14"
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037355457299906560"
}Query Booth Information
Brief Description
- This API is used to query booth information.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | SentryHost | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774578631205",
"Nonce": "cfh6rc82o2xd",
"Sign": "neekq5zdwi6a3bcn0owtfwxqo9nmher8q8wqbc+4sly="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» Name | string | true | Sentry post name | Name of the sentry post. |
| »» Category | integer | true | Sentry post type | 1 - Sentry post billing software, 2 - Sentry post background service. |
| »» IP | string | true | Sentry post IP address | IP address of the sentry post. |
| »» TcpPort | integer | true | Sentry post TCP communication port | TCP communication port of the sentry post. |
| »» BSPort | integer | true | Background port for B/S sentry post | Background port for B/S sentry post. |
| »» CreationTime | string | true | Creation time | Timestamp when the data was created. |
| »» Longitude | number | null | false | Sentry post longitude | Longitude of the sentry post. |
| »» Latitude | number | null | false | Sentry post latitude | Latitude of the sentry post. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 1,
"No": "1772492942363478",
"Name": "127.0.0.1",
"Category": 1,
"IP": "192.168.22.23",
"TcpPort": null,
"BSPort": 7702,
"CreationTime": "2026-03-02 23:09:02",
"Longitude": null,
"Latitude": null
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037356557084164096"
}Query Lane Information
Brief Description
- This API is used to query lane information.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | Lane | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774580431571",
"Nonce": "lmwjhyoe85x6",
"Sign": "s6gifh7clisx+rfpvqku57sfelrjb5skoikd+ryq9ky="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» LaneName | string | null | true | Lane name | Name of the lane. |
| »» LaneType | integer | true | Lane type | Lane type: 1 - Vehicle lane, 2 - Non-vehicle lane (pedestrian passage). |
| »» LaneDutyMode | integer | true | Lane duty mode | Lane duty mode: 0 - Unmanned lane, 1 - On-site duty. |
| »» CameraMode | integer | true | Camera mode | Camera mode: 1 - Single camera, 2 - Dual camera, 3 - Multi-camera. |
| »» IdInterval | integer | true | Camera recognition interval | Recognition interval in seconds (effective for [dual camera mode, multi-camera mode]). |
| »» IsBackCar | integer | null | true | Enable reverse car detection | Whether reverse car detection is enabled: 0 - Disabled, 1 - Enabled. |
| »» IsCharge | integer | true | Enable lane charging | Whether charging is enabled for the lane: 0 - Disabled, 1 - Enabled. |
| »» SentryHostNo | string | true | Sentry post number the lane belongs to | Number of the sentry post the lane belongs to. |
| »» CreationTime | string | true | Creation time | Timestamp when the data was created. |
| »» IsSense | integer | true | Enable ground loop judgment for license-plate-less vehicle QR code scanning | Enable ground loop judgment for license-plate-less vehicle QR code scanning: 0 - Disabled, 1 - Enabled. |
| »» IsSameInOut | integer | true | Same entry/exit mode | Whether it is the same entry/exit mode: 0 - No, 1 - Yes. |
| »» SameInOutLaneNo | string | null | true | Associated lane number for same entry/exit mode | Associated lane number for same entry/exit mode. |
| »» SameInOutType | integer | true | Entry/exit type for lane in same entry/exit mode | Entry/exit type for lane in same entry/exit mode: 0 - Entry, 1 - Exit. |
| »» IsEnableBoard | integer | true | Enable lane control board | Whether lane control board is enabled: 0 - Disabled, 1 - Enabled. |
| »» LaneLinkAreas | [object] | null | true | Area information bound to the current lane | Area information bound to the current lane. |
| »»» No | string | true | Record number | Unique number for the current record. |
| »»» AreaNo | string | true | Associated area number | Number of the associated area. |
| »»» InOutMode | integer | true | Entry/exit mode of the lane in the current area | Entry/exit mode of the lane in the current area: 0 - Exit lane, 1 - Entry lane. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 2,
"Results": [
{
"Uid": 1,
"No": "1",
"LaneName": "Entrance Lane",
"LaneType": 1,
"IdInterval": 3,
"IsBackCar": 0,
"IsCharge": 0,
"OpenGateAndVoice": 1,
"SentryHostNo": "1772492942363478",
"CreationTime": "2026-03-02 23:09:02",
"IsSense": 1,
"IsSameInOut": 0,
"SameInOutLaneNo": null,
"SameInOutType": 0,
"IsEnableBoard": 0,
"LaneLinkAreas": [
{
"No": "1774609216714465",
"AreaNo": "1772492942540835",
"InOutMode": 1
}
]
},
{
"Uid": 2,
"No": "2",
"LaneName": "Exit Lane",
"LaneType": 1,
"IdInterval": 3,
"IsBackCar": 0,
"IsCharge": 1,
"OpenGateAndVoice": 1,
"SentryHostNo": "1772492942363478",
"CreationTime": "2026-03-02 23:09:02",
"IsSense": 1,
"IsSameInOut": 0,
"SameInOutLaneNo": null,
"SameInOutType": 0,
"IsEnableBoard": 0,
"LaneLinkAreas": [
{
"No": "1774609216715573",
"AreaNo": "1772492942540835",
"InOutMode": 0
}
]
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037364113160568832"
}Query Plate Type Information
Brief Description
- This API is used to query plate type information.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | CardType | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774583643820",
"Nonce": "8pi08ligfp02",
"Sign": "mxzqjrpgn2ahlyqvckroofp4ivq/e0xjh9l4br1txay="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» ParkingCardTypeName | string | null | true | Vehicle plate type name | Name of the vehicle plate type. |
| »» IsMoreCar | boolean | true | Whether used for multiple vehicles per parking space | Whether used for multiple vehicles per parking space. |
| »» CreationTime | string | true | Creation time | Timestamp when the data was created. |
| »» OperatorName | string | null | true | Operator name | Name of the operator who performed the action. |
| »» Category | string | true | Vehicle plate classification | Vehicle plate classification: 3648, Temporary Vehicle D 3649, Temporary Vehicle C 3650, Temporary Vehicle B 3651, Temporary Vehicle A 3652, Monthly Vehicle A 3653, Monthly Vehicle B 3654, Monthly Vehicle C 3655, Monthly Vehicle D 3656, Free Vehicle 3657, Prepaid Vehicle |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 18,
"Results": [
{
"Uid": 1,
"No": "1772492942389944",
"ParkingCardTypeName": "Monthly Rental Car A",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3652"
},
{
"Uid": 2,
"No": "1772492942389782",
"ParkingCardTypeName": "Monthly Rental Car B",
"IsMoreCar": true,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3653"
},
{
"Uid": 3,
"No": "1772492942389940",
"ParkingCardTypeName": "Monthly Rental Car C",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3654"
},
{
"Uid": 4,
"No": "1772492942389560",
"ParkingCardTypeName": "Monthly Rental Car D",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3655"
},
{
"Uid": 5,
"No": "1772492942389853",
"ParkingCardTypeName": "Monthly Rental Car E",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3661"
},
{
"Uid": 6,
"No": "1772492942389129",
"ParkingCardTypeName": "Monthly Rental Car F",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3662"
},
{
"Uid": 7,
"No": "1772492942389699",
"ParkingCardTypeName": "Monthly Rental Car G",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3663"
},
{
"Uid": 8,
"No": "1772492942389607",
"ParkingCardTypeName": "Monthly Rental Car H",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3664"
},
{
"Uid": 9,
"No": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3651"
},
{
"Uid": 10,
"No": "1772492942389238",
"ParkingCardTypeName": "Temporary Car B",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3650"
},
{
"Uid": 11,
"No": "1772492942389881",
"ParkingCardTypeName": "Temporary Car C",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3649"
},
{
"Uid": 12,
"No": "1772492942389922",
"ParkingCardTypeName": "Temporary Car D",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3648"
},
{
"Uid": 13,
"No": "1772492942389720",
"ParkingCardTypeName": "Temporary Car E",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3647"
},
{
"Uid": 14,
"No": "1772492942389279",
"ParkingCardTypeName": "Temporary Car F",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3646"
},
{
"Uid": 15,
"No": "1772492942389113",
"ParkingCardTypeName": "Temporary Car G",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3645"
},
{
"Uid": 16,
"No": "1772492942389629",
"ParkingCardTypeName": "Temporary Car H",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3644"
},
{
"Uid": 17,
"No": "1772492942389454",
"ParkingCardTypeName": "Free Car",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3656"
},
{
"Uid": 18,
"No": "1772492942389308",
"ParkingCardTypeName": "Stored Value Car",
"IsMoreCar": false,
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null,
"Category": "3657"
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037377586011602944"
}Query Plate Color Information
Brief Description
- This API is used to query plate information.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | CarType | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774583183257",
"Nonce": "92an8dgzpc9n",
"Sign": "np8x2cbizdylxokvecrq1e0mhmxin4mitk6qc1glh5e="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Name of the vehicle type. |
| »» CreationTime | string | true | Creation time | Timestamp when the data was created. |
| »» OperatorName | string | null | true | Operator name | Name of the operator who performed the action. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 9,
"Results": [
{
"Uid": 1,
"No": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 2,
"No": "1772492942395558",
"VehicleTypeName": "Yellow Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 3,
"No": "1772492942395297",
"VehicleTypeName": "Green Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 4,
"No": "1772492942395388",
"VehicleTypeName": "Black Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 5,
"No": "1772492942395917",
"VehicleTypeName": "White Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 6,
"No": "1772492942395140",
"VehicleTypeName": "No Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 7,
"No": "1772492942395720",
"VehicleTypeName": "0 Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 8,
"No": "1772492942395498",
"VehicleTypeName": "Yellow-Green Plate Vehicle",
"CreationTime": "2026-03-02 23:09:02",
"OperatorName": null
},
{
"Uid": 9,
"No": "1773111596539522",
"VehicleTypeName": "test",
"CreationTime": "2026-03-10 02:59:56",
"OperatorName": null
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037375654295535616"
}Query Lane Ground Loop Barrier Status
Brief Description
- This API is used to query the status of ground loop and barrier gates in a lane.
Request URL
http://localhost:8888/Api/V2/OpenApi/GetLaneStatus
Request Method
- GET
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » LaneNo | body | string | Yes | Lane number to query | Lane number to query |
Request Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"TimeStamp": "1774591364770",
"Nonce": "389012",
"Sign": "fy23v3b2rlby2geg94sax3tge0j2fdd2hszwtzquf18=",
"Data": {
"LaneNo": "1"
}
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » GataStatus | integer | true | Barrier gate status | Barrier gate status: 0 - Closed, 1 - Open, -1 - Unknown status |
| » GateLongOpen | integer | true | Whether barrier gate is set to stay open | Whether barrier gate is set to stay open: 0 - Disabled, 1 - Enabled, -1 - Unknown |
| » GSStatus | integer | true | Ground loop status | Ground loop status: 0 - No detection, 1 - Detection active, -1 - Unknown status |
| » IDCameraStatus | integer | true | Main recognition camera status | Main recognition camera status: 0 - Device offline, 1 - Device online |
Return Example
{
"Data": {
"GataStatus": -1,
"GateLongOpen": 0,
"GSStatus": -1,
"IDCameraStatus": 0
},
"ResultCode": 200,
"ResultMsg": "Lane ground loop gate status retrieved successfully!",
"ResultId": "2037409969930797056"
}Query Lane Current Order
Brief Description
- This API is used to query the current order of a lane.
Request URL
http://localhost:8888/Api/V2/OpenApi/GetLaneOrder
Request Method
- GET
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » LaneNo | body | string | Yes | Lane number to query | Lane number to query |
Request Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"TimeStamp": "1774593426011",
"Nonce": "272946",
"Sign": "cmwzgjt3qj+thzq3myrdjqgzbng3qkrdid/kqriqlwo=",
"Data": {
"LaneNo": "2"
}
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| » CouponSchemeNos | [string] | true | Collection of used coupon codes | Collection of coupon codes that have been used. |
| » ChargeMoney | number | true | Current billing amount | Current billing amount. |
Return Example
{
"Data": {
"OrderNo": "1774546385410449-162YRG",
"ChargeMoney": 5.0,
"CouponKey": []
},
"ResultCode": 200,
"ResultMsg": "Lane order information retrieved successfully!",
"ResultId": "2037418615238590464"
}Query Vehicle Record
Brief Description
- This API is used to query vehicle records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | MonthlyCar | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774593936520",
"Nonce": "l7vkb8xj0ul7",
"Sign": "poxjnfarjespzerzqole5tlfitetgn/hlhp3/kjveea="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» SystemSpotNumber | string | true | System parking space number | System parking space number. |
| »» ParkingSpotNumber | string | null | true | Parking lot space number | Parking lot space number. |
| »» OwnerParkingSpaceCount | integer | true | Owner’s parking space count | Number of parking spaces owned by the vehicle owner. |
| »» OwnerName | string | null | true | Owner name | Name of the vehicle owner recorded in the issued vehicle record. |
| »» OwnerNo | string | null | true | Owner number | Unique identifier number of the vehicle owner. |
| »» OwnerIDCard | string | null | true | Owner ID card information | Owner ID card information (data needs to be decrypted). |
| »» OwnerLicense | string | null | true | Owner driver’s license | Owner driver’s license (data needs to be decrypted). |
| »» OwnerAddress | string | null | true | Owner address | Residential address of the vehicle owner. |
| »» PhoneNumber | string | true | Phone number | Phone number (data needs to be decrypted). |
| string | null | true | Email address | Email address (data needs to be decrypted). | |
| »» StartTime | string | null | true | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | string | null | true | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» StoredVehicleBalance | number | true | Prepaid vehicle balance | Prepaid vehicle balance (in yuan, accurate to two decimal places). |
| »» VehicleTypeNo | string | null | true | Vehicle type number | Vehicle type number. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Vehicle type name. |
| »» ParkingCardTypeNo | string | null | true | License plate type number | License plate type number. |
| »» ParkingCardTypeName | string | null | true | License plate type name | License plate type name. |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
| »» CreationTime | string | true | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
| »» Status | integer | true | License plate status | License plate status: 1 - Normal, 2 - Blacklist, 3 - Disabled. |
| »» EnableOffline | integer | true | Whitelist enable | Automatic gate opening when camera is offline (whitelist): 0 - Disabled, 1 - Enabled. |
| »» StopSpaceList | [object] | true | Vehicle allowed parking area information | Information about areas where the vehicle is allowed to park. |
| »»» No | string | true | Record number | Unique number for the current record. |
| »»» Type | integer | true | Parking area type | Parking area type: 0 - Allowed in all areas, 1 - Allowed in specified areas. |
| »»» AreaNos | string | true | Allowed area number array | Array of allowed area numbers, e.g.: [“1692060223198448”]. |
| »»» AreaName | string | true | Brief display of allowed area names | Brief display of allowed area names. |
| »»» SpaceCount | integer | true | Number of available parking spaces in the area | Number of available parking spaces in the area. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 23,
"No": "1774336597411515",
"LicensePlateNumber": "DASH1",
"SystemSpotNumber": "C00003",
"ParkingSpotNumber": "",
"OwnerParkingSpaceCount": 1,
"OwnerName": "",
"OwnerNo": "1774322212039836",
"OwnerIDCard": "",
"OwnerLicense": "",
"OwnerAddress": "",
"PhoneNumber": "",
"Email": "",
"StartTime": "2026-03-24 00:00:00",
"EndTime": "2026-04-23 23:59:59",
"StoredVehicleBalance": 0,
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389944",
"ParkingCardTypeName": "Monthly Rental Car A",
"OperatorName": "qq",
"CreationTime": "2026-03-24 03:16:52",
"Remarks": "",
"Status": 1,
"EnableOffline": 1,
"IsDeleteOwner": false,
"StopSpaceList": [
{
"No": "1774336597411678",
"Type": 0,
"AreaNos": "[\"0\"]",
"AreaName": "All Zone",
"SpaceCount": 1
}
],
"StatusText": "Normal"
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037420756380450816"
}Query Blacklist Records
Brief Description
- This API is used to query blacklist records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | BlackList | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774666337712",
"Nonce": "gzwnmt2f85kn",
"Sign": "94yrnyiz9kvdnozdfomnirgg+klb2mzgrmfoccscqhk="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» OwnerName | string | null | true | Contact person name | Contact person name. |
| »» PhoneNumber | string | true | Phone number | Phone number. |
| »» StartTime | string | null | true | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | string | null | true | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
| »» CreationTime | string | true | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
| »» Status | integer | true | Blacklist status | Status value: 1 - Enabled, 0 - Disabled. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 3,
"No": "BL1774695130227262",
"LicensePlateNumber": "ABC123",
"OwnerName": "",
"PhoneNumber": "",
"StartTime": "2026-03-28 00:00:00",
"EndTime": "2026-04-30 00:00:00",
"Remarks": "1",
"CreationTime": "2026-03-28 10:52:10",
"OperatorName": "qq",
"Status": 1
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037724429413285888"
}Query Parking Order Records
Brief Description
- Query parking order records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | ParkingOrder | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774666807228",
"Nonce": "b4q1jiesvz40",
"Sign": "5uihmatmcmrzdekraeipvyaoragmflzkpbli1ezbjl4="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» EntryTime | string | null | true | Entry time | Entry time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» ExitTime | string | null | true | Exit time | Exit time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EntryLaneNo | string | null | true | Entry lane number | Entry lane number. |
| »» EntryLaneName | string | null | true | Entry lane name | Entry lane name. |
| »» ExitLaneNo | string | null | true | Exit lane number | Exit lane number. |
| »» ExitLaneName | string | null | true | Exit lane name | Exit lane name. |
| »» EntryOperatorName | string | null | true | Entry operator | Entry operator name. |
| »» ExitOperatorName | string | null | true | Exit operator | Exit operator name. |
| »» ParkingAreaNo | string | true | Parking area number | Current parking area number. |
| »» ParkingAreaName | string | null | true | Parking area name | Current parking area name. |
| »» VehicleTypeNo | string | null | true | Vehicle type number | Vehicle type number. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Vehicle type name. |
| »» EntryImageUrl | string | null | true | Entry capture image URL | Entry passage capture image URL. If cloud platform is enabled with image storage, this is a cloud-stored image URL. |
| »» ExitImageUrl | string | null | true | Exit capture image URL | Exit passage capture image URL. If cloud platform is enabled with image storage, this is a cloud-stored image URL. |
| »» ParkingCardTypeNo | string | null | true | License plate type number | License plate type number. |
| »» ParkingCardTypeName | string | null | true | License plate type name | License plate type name. |
| »» OrderStatus | integer | true | Parking order status | For details, refer to the type enumeration/order status enumeration. |
| »» IsFreePass | boolean | true | Whether free pass is granted | Whether free pass is granted. |
| »» FreePassReason | string | null | true | Free pass reason | Reason for granting free pass when vehicle is allowed free passage. |
| »» TotalAmountDue | number | true | Total amount due | Total amount due (in yuan, accurate to two decimal places). |
| »» TotalAmountPaid | number | true | Total amount paid | Total amount paid (in yuan, accurate to two decimal places). |
| »» IsVehicleLocked | boolean | true | Whether vehicle is locked | Whether vehicle is locked. |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 140,
"OrderNo": "1774695602882864-BCDE11",
"LicensePlateNumber": "ABCDE11",
"EntryTime": "2026-02-27 08:59:25",
"ExitTime": "0001-01-01 00:00:00",
"EntryLaneNo": "1",
"EntryLaneName": "Entrance Lane",
"ExitLaneNo": null,
"ExitLaneName": null,
"EntryOperatorName": "qq",
"ExitOperatorName": null,
"ParkingAreaNo": "1772492942540835",
"ParkingAreaName": "Outer Field",
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"EntryImageUrl": "",
"ExitImageUrl": null,
"ParkingCardTypeNo": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"OrderStatus": 200,
"IsFreePass": false,
"FreePassReason": null,
"TotalAmountDue": 0,
"TotalAmountPaid": 0,
"IsVehicleLocked": false,
"Remarks": ""
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037726398689345536"
}Query Payment Records
Brief Description
- This API is used to query payment records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | PaymentOrder | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774667424134",
"Nonce": "gqxypbbwp95d",
"Sign": "1a1t6trlfdzbjtboxnx2hk0cepz4of+3m7gx0i9q+c8="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» OrderType | string | true | Order type | Order type (5902 - Monthly card recharge, 5901 - Temporary vehicle payment, 5903 - Wallet recharge, 5905 - Prepaid vehicle deduction, 5910 - Parking space renewal) |
| »» SystemSpotNumber | string | null | true | System parking space number | System parking space number. |
| »» VehicleTypeNo | string | null | true | Vehicle type number | Vehicle type number. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Vehicle type name. |
| »» ParkingCardTypeNo | string | null | true | License plate type number | License plate type number. |
| »» ParkingCardTypeName | string | null | true | License plate type name | License plate type name. |
| »» StartTime | string | null | true | Recharge start time | Recharge start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | string | null | true | Recharge end time | Recharge end time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» BeforeEndTime | string | null | true | End time before recharge | End time before recharge, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OwnerNo | string | null | true | Owner number | Unique identifier number of the vehicle owner. |
| »» OwnerName | string | null | true | Owner name | Name of the vehicle owner recorded in the issued vehicle record. |
| »» TotalAmountDue | number | true | Total amount due | Total amount due (in yuan, accurate to two decimal places). |
| »» TotalAmountPaid | number | true | Total amount paid | Total amount paid (in yuan, accurate to two decimal places). |
| »» DiscountAmount | number | true | Discount amount | Discount amount (in yuan, accurate to two decimal places). |
| »» StoredValueDeduction | number | true | Prepaid value deduction | Prepaid value deduction. |
| »» SelfMoney | number | true | Self-service cash payment amount | Self-service cash payment amount. |
| »» OutReduceMoney | number | true | Change amount for self-service cash payment | Change amount for self-service cash payment. |
| »» PaymentMethod | string | true | Payment method number | For details, refer to the type enumeration/payment method enumeration information. |
| »» PaymentStatus | integer | true | Payment status | Payment status: 1 - Success, 0 - Unpaid, 2 - Failed, 3 - User canceled payment. |
| »» EntryTime | string | null | true | Entry time | Entry time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» PaymentTime | string | true | Payment time | Payment time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» ParkingDuration | number | true | Parking duration | Parking duration (in minutes). |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
| »» CreationTime | string | true | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» PaymentScene | integer | true | Payment scene | For details, refer to the type enumeration/payment scene enumeration. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 33,
"No": "MC1774322212074210",
"OrderNo": "",
"LicensePlateNumber": "DASH1",
"OrderType": "5902",
"SystemSpotNumber": "C00003",
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942395203",
"ParkingCardTypeName": "Monthly Rental Car A",
"StartTime": "2026-04-23 23:59:59",
"EndTime": "2026-03-24 00:00:00",
"BeforeEndTime": null,
"OwnerNo": "1774322212039836",
"OwnerName": "",
"TotalAmountDue": 0,
"TotalAmountPaid": 0,
"DiscountAmount": 0,
"StoredValueDeduction": 0,
"SelfMoney": 0,
"OutReduceMoney": 0,
"PaymentMethod": "79001",
"PaymentStatus": 1,
"EntryTime": null,
"PaymentTime": "2026-03-24 03:16:52",
"ParkingDuration": 0,
"Remarks": "",
"OperatorName": "qq",
"CreationTime": "2026-03-24 03:16:52",
"PaymentScene": 0
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037728986168066048"
}Query Payment Detail Records
Brief Description
- This API is used to query payment detail records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | PaymentOrderDetail | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774668088594",
"Nonce": "d8b74lmheaiz",
"Sign": "4kwgodq4slyy1w6nsibfve7ln1vxvzqwaec2gzmgiuu="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| »» PaymentOrderNo | string | true | Payment order number | Payment order number. |
| »» OrderDetailNo | string | null | true | Parking detail number | Parking detail number. |
| »» StartTime | string | null | true | Billing start time | Billing start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | string | null | true | Billing end time | Billing end time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» TimeCount | integer | null | true | Time period | Time period (in minutes). |
| »» OrderType | string | true | Order type | Order type (5902 - Monthly card recharge, 5901 - Temporary vehicle payment, 5903 - Wallet recharge, 5905 - Prepaid vehicle deduction, 5910 - Parking space renewal) |
| »» AreaNo | string | null | true | Parking area number | Parking area number. |
| »» AreaName | string | null | true | Parking area name | Parking area name. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» VehicleTypeNo | string | null | true | Vehicle type number | Vehicle type number. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Vehicle type name. |
| »» ParkingCardTypeNo | string | null | true | License plate type number | License plate type number. |
| »» ParkingCardTypeName | string | null | true | License plate type name | License plate type name. |
| »» PaymentMethod | string | true | Payment method number | For details, refer to the type enumeration/payment method enumeration information. |
| »» TotalAmountDue | number | true | Total amount due | Total amount due (in yuan, accurate to two decimal places). |
| »» TotalAmountPaid | number | true | Total amount paid | Total amount paid (in yuan, accurate to two decimal places). |
| »» DiscountAmount | number | true | Discount amount | Discount amount (in yuan, accurate to two decimal places). |
| »» PaymentStatus | integer | true | Payment status | Payment status: 1 - Success, 0 - Unpaid, 2 - Failed, 3 - User canceled payment. |
| »» PassageLaneNo | string | null | true | Passage lane number | Passage lane number. |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
| »» CreationTime | string | true | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
| »» StoredValueDeduction | number | true | Prepaid value deduction | Prepaid value deduction. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 33,
"No": "PD1774322212119978-ASH1",
"PaymentOrderNo": "MC1774322212074210",
"OrderNo": "MC1774322212074210",
"OrderDetailNo": null,
"StartTime": null,
"EndTime": "2026-03-24 03:16:52",
"TimeCount": 0,
"OrderType": "5902",
"AreaNo": "",
"AreaName": null,
"LicensePlateNumber": "DASH1",
"ParkingCardTypeNo": "1772492942389944",
"ParkingCardTypeName": "Monthly Rental Car A",
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"PaymentMethod": "79001",
"TotalAmountDue": 0,
"DiscountAmount": 0,
"TotalAmountPaid": 0,
"PaymentStatus": 1,
"PassageLaneNo": null,
"Remarks": null,
"CreationTime": "2026-03-24 03:16:52",
"OperatorName": "qq",
"StoredValueDeduction": 0
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037731773102718976"
}Query Gate Release Record
Brief Description
- This API is used to query gate release records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | OpenGate | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774668802564",
"Nonce": "bcpf88dr2zvx",
"Sign": "yjqgppa5xtzw/gu5yhyy+rhhvt/wvzjitz8eytzwpls="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | true | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» GateSwitchType | integer | true | Manual gate switch type | For details, refer to the type enumeration/manual gate switch type enumeration. |
| »» OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» PassageLaneNo | string | true | Passage lane number | Passage lane number. |
| »» PassageLaneName | string | true | Passage lane name | Passage lane name. |
| »» DeviceNo | string | null | true | Device number | Device number. |
| »» DeviceName | string | null | true | Device name | Device name. |
| »» VehicleTypeNo | string | null | true | Vehicle type number | Vehicle type number. |
| »» VehicleTypeName | string | null | true | Vehicle type name | Vehicle type name. |
| »» ParkingCardTypeNo | string | null | true | License plate type number | License plate type number. |
| »» ParkingCardTypeName | string | null | true | License plate type name | License plate type name. |
| »» SpecialVehicleNo | string | null | true | Special vehicle number | Special vehicle number. |
| »» SpecialVehicleName | string | null | true | Special vehicle name | Special vehicle name. |
| »» PassageImageUrl | string | true | Passage capture image URL | Passage capture image URL (this is a local LAN HTTP address). |
| »» PassageTime | string | true | Passage time | Passage time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
| »» OperationTime | string | true | Operation time | Operation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
| »» TotalAmountPaid | number | true | Total amount paid | Total amount collected after license-plate-less vehicle exit. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 1,
"No": "ER1774697600304463",
"GateSwitchType": 1,
"OrderNo": null,
"LicensePlateNumber": null,
"PassageLaneNo": "2",
"PassageLaneName": "Exit Lane",
"DeviceNo": "1772492942377879",
"DeviceName": "Exit Camera",
"VehicleTypeNo": null,
"VehicleTypeName": null,
"ParkingCardTypeNo": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"SpecialVehicleNo": "",
"SpecialVehicleName": "",
"PassageImageUrl": "http://192.168.22.23:8888/CameraCaptures//1772492942363478/202603/28/dfc7b20adf202603281133191563007_Online.jpg",
"PassageTime": "2026-03-28 11:33:20",
"OperatorName": "qq",
"OperationTime": "2026-03-28 11:33:20",
"Remarks": "[Exit Camera]Release gate successfully!",
"TotalAmountPaid": 0
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037734767680585728"
}Query Coupon Scheme
Brief Description
- This API is used to query coupon schemes.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | CouponScheme | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774669296136",
"Nonce": "a33ys6g6sspg",
"Sign": "tejosus65710mv720egz4ztpug3ai2zlgbqapdiwama="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» Name | string | true | Coupon scheme name | Coupon scheme name. |
| »» Type | string | true | Coupon discount type | Coupon discount type (101 - Discount amount, 102 - Discount duration, 103 - Discount ratio, 104 - Free until specified time) |
| »» Amount | number | true | Discount amount (for amount type) | Discount amount for amount type (unit: yuan). |
| »» Duration | number | true | Discount duration (for duration type) | Discount duration for duration type (unit: minutes). |
| »» Ratio | number | true | Discount ratio (for ratio type) | Discount ratio for ratio type. |
| »» VaildTime | string | null | true | Free until specified time | Free until specified time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Scene | integer | true | Coupon scheme usage scene | Coupon scheme usage scene: 0 - Only for in-field discount, 1 - Only for exit discount, 2 - Exit and in-field discount. |
| »» CreationTime | string | true | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | string | null | true | Operator name | Name of the operator. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 9,
"No": "1774060298299594",
"Name": "forfree",
"Type": "103",
"Amount": 0,
"Duration": 0,
"Ratio": 0,
"VaildTime": null,
"Enable": null,
"Scene": 2,
"CreationTime": "2026-03-21 02:31:38",
"OperatorName": "admin"
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037736837838045184"
}Query Plate Coupon Records
Brief Description
- This API is used to query plate coupon records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Query
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | PlateCoupon | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » PageIndex | body | integer | Yes | Page Index | Target page number (starts from 1 for ease of use) |
| » PageSize | body | integer | Yes | Page Size | Default: 20 records; Maximum: 100 |
| » OrderBy | body | string | No | Sort Field | Field name to sort by; defaults to system-defined order if omitted |
| » OrderType | body | integer | Yes | Sort Order | 0 = ASC (ascending), 1 = DESC (descending) |
| » QueryCondition | body | [object] | No | Query Conditions | Array of query condition objects |
| »» Field | body | string | Yes | Query Field | Name of the field to query |
| »» Operator | body | integer | Yes | Query Operator | Operator code; refer to “Query Operator Enum” for details |
| »» Value | body | string | Yes | Query Value | Value corresponding to the field type |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"PageIndex": 1,
"PageSize": 20,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774669664385",
"Nonce": "vafyomon72wl",
"Sign": "bgcg28vktlpata+lm1znvrfqz96o8htcefha+gprcsk="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » PageIndex | integer | true | Current page number | Page number starting from 1. |
| » PageSize | integer | true | Page size | Number of items per page. |
| » TotalCount | integer | true | Total data count | Total number of data items. |
| » Results | [object] | null | false | Query results | Results of the current data query. |
| »» Uid | integer | true | Record primary key | Unique identifier for the record. |
| »» No | string | true | Record number | Unique number for the record. |
| »» CouponSchemeNo | string | true | Coupon scheme number | Coupon scheme number. |
| »» Type | string | true | Coupon discount type | Coupon discount type (101 - Discount amount, 102 - Discount duration, 103 - Discount ratio, 104 - Free until specified time) |
| »» Value | number | true | Discount value | For discount amount: the amount in yuan; for discount duration: the duration in minutes; for discount ratio: the discount ratio (greater than 0 and less than 10). |
| »» StartTime | string | null | true | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | string | null | true | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | string | null | true | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» BusinessName | string | null | true | Merchant name | Merchant name. |
| »» CreationTime | string | false | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | string | null | true | Remarks information | Remarks information. |
Return Example
{
"Data": {
"PageIndex": 1,
"PageSize": 20,
"TotalCount": 1,
"Results": [
{
"Uid": 8,
"No": "CF1774698341290726",
"CouponSchemeNo": "1774060298299594",
"Type": "103",
"Value": 0,
"StartTime": null,
"EndTime": null,
"OrderNo": "1774695602882864-BCDE11",
"LicensePlateNumber": "ABCDE11",
"BusinessName": null,
"CreationTime": "2026-03-28 11:45:41",
"Remarks": null
}
]
},
"ResultCode": 200,
"ResultMsg": "Query data successfully",
"ResultId": "2037738382377910272"
}Query Parking Fee for Specified Order
Brief Description
- This API is used to query the current parking fee based on the parking order.
Request URL
http://localhost:8888/Api/V2/OpenApi/GetOrderPrice
Request Method
- GET
Request Content-Type
application/json
Request Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » OrderNo | body | string | Yes | Parking order to query | Parking order to query |
| » LicensePlateNumber | body | string | No | License plate number | License plate number |
| » PlateCouponNo | body | string | No | Coupon code | Coupon code |
Request Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"TimeStamp": "1774670142512",
"Nonce": "495296",
"Sign": "+94xw4q0vudgx4wit4elyz30z0erz8g0y0gf/8sy1ys=",
"Data": {
"OrderNo": "1774695602882864-BCDE11"
}
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
| » CouponSchemeNos | [string] | true | Collection of used coupon codes | Collection of used coupon codes. |
| » LicensePlateNumber | number | true | License plate number | License plate number. |
| » EntryTime | string | true | Entry time | Entry time. |
| » CalcTime | string | true | Billing time | Billing time. |
| » TotalAmountDue | string | true | Total amount due | Total amount due. |
| » TotalAmountPaid | string | true | Total amount paid | Total amount paid. |
| » DiscountAmount | string | true | Discount amount | Discount amount. |
| » CalcDetail | string | true | Billing details | Billing details. |
| »» AreaNo | string | true | Area code | Area code. |
| »» AreaName | string | true | Area name | Area name. |
| »» StartTime | string | true | Start time | Start time. |
| »» EndTime | string | true | End time | End time. |
| »» CalcAmount | string | true | Billing amount | Billing amount. |
| »» FreeMinutes | string | true | Free minutes | Free minutes. |
| »» StayMinutes | string | true | Parking duration | Parking duration (in minutes). |
| »» Remarks | string | true | Remarks | Remarks. |
| »» IsOverTime | string | true | Whether overtime | Whether overtime (0 - No, 1 - Yes). |
| »» IsCarExpire | string | true | Whether expired | Whether expired (0 - No, 1 - Yes). |
Return Example
{
"Data": {
"OrderNo": "1774695602882864-BCDE11",
"LicensePlateNumber": "ABCDE11",
"EntryTime": "2026-02-27 08:59:25",
"CalcTime": "2026-03-28 11:55:42",
"TotalAmountDue": 5.0,
"TotalAmountPaid": 5.0,
"DiscountAmount": 0.0,
"CalcDetail": [
{
"AreaNo": "1772492942540835",
"AreaName": "Outer Field",
"StartTime": "2026-02-27 08:59:25",
"EndTime": "2026-03-28 11:55:42",
"CalcAmount": 5.0,
"DiscountAmount": null,
"FreeMinutes": 0,
"StayMinutes": 41936,
"Remarks": "Charged by Temporary Car A",
"IsOverTime": 0,
"IsCarExpire": 0
}
],
"PlateCouponNos": [
{
"No": "CF1774698341290726",
"Name": "0.00% off"
}
]
},
"ResultCode": 200,
"ResultMsg": "Successfully retrieved parking fee information for the specified parking order!",
"ResultId": "2037740387880173568"
}5. Notification Interfaces(V2.0)
In-Parking Record Change Notification (Including Modify and Close)
Brief Description
- This API is used to manage modifications to in-parking records, including license plate number, license plate type, vehicle type, entry time, order closure, and order remarks.
Request URL
http://localhost:8888/Api/V2/OpenApi/Notice
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | ModifyParkingOrder | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » NoticeType | body | integer | Yes | Notification type | Notification type: 0 - Update, 1 - Delete. Note: Delete operation here refers to closing in-field orders. |
| » Items | body | [object] | Yes | Notification data collection | Collection of notification data |
| »» OrderNo | body | string | null | Yes | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | body | string | null | Yes | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» VehicleTypeNo | body | string | null | Yes | Vehicle type number | Vehicle type number. |
| »» ParkingCardTypeNo | body | string | null | Yes | License plate type number | License plate type number. |
| »» EntryTime | body | string | null | Yes | Entry time | Entry time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | body | string | null | Yes | Remarks information | Remarks information. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"NoticeType": 0,
"Items": [
{
"OrderNo": "1774695602882864-BCDE11",
"EntryTime": "2026-03-28 14:01:53",
"Remarks": "test"
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774677754883",
"Nonce": "fve3txy88g8d",
"Sign": "3cnpkchws2g/hfa896vruz82omxcqpmr4ckxm//fpge="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Order [1774695602882864-BCDE11] on-site record updated successfully",
"ResultId": "2037772316146958336"
}Notify Vehicle Changes (Including Add, Edit, Delete)
Brief Description
- This API is used to manage the addition, modification and deletion of vehicle records.
- Note: In the parking system, vehicles belonging to the same owner share the same start time and end time. Only one vehicle type is allowed per owner. If multiple vehicle records for the same owner are submitted during create or update operations, the record with the latest end time shall be used as the reference to update the database.
Note: In the current version, fixed vehicles are granted access to all zones by default. No API is available to modify this configuration.
Note
1.The combination of No, ParkingSpotNumber and OwnerNo is unique.If all three fields match an existing record, an update will be performed; otherwise, a new record will be created.
2.For the one-owner-multiple-vehicles scenario:If two license plates are uploaded in the initial creation, and a third plate is submitted later, the system will update the first license plate instead of adding a new record.
3.For the one-owner-multiple-vehicles scenario:If two license plates are registered initially, and a third license plate is included in the second request, the system will process all three plates without updating existing records.
4.If a vehicle that has already entered the parking lot is deregistered via this API, the vehicle will be converted to a temporary vehicle.Re-registration will close the previous parking order.
Request URL
http://localhost:8888/Api/V2/OpenApi/Notice
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | MonthlyCar | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | null | Yes | Response data | Data object returned by the API. |
| » NoticeType | body | integer | Yes | Notification type | Notification type: 0 - Add or Update, 1 - Delete. |
| » Items | body | [object] | Yes | Notification data collection | Collection of notification data |
| »» No | body | string | Yes | Record number | Unique number for the current record. |
| »» LicensePlateNumber | body | string | null | Yes | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» ParkingSpotNumber | body | string | null | Yes | Parking lot space number | Parking lot space number. |
| »» OwnerParkingSpaceCount | body | integer | Yes | Owner’s parking space count | Number of parking spaces owned by the vehicle owner. |
| »» OwnerName | body | string | null | Yes | Owner name | Name of the vehicle owner recorded in the issued vehicle record. |
| »» OwnerNo | body | string | null | Yes | Owner number | Unique identifier number of the vehicle owner. |
| »» OwnerIDCard | body | string | null | Yes | Owner ID card information | Owner ID card information. |
| »» OwnerLicense | body | string | null | Yes | Owner driver’s license | Owner driver’s license. |
| »» OwnerAddress | body | string | Yes | Owner address | Residential address of the vehicle owner. |
| »» PhoneNumber | body | string | Yes | Phone number | Phone number. |
| body | string | null | Yes | Email address | Email address. | |
| »» StartTime | body | string | null | Yes | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | body | string | null | Yes | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» StoredVehicleBalance | body | number | Yes | Prepaid vehicle balance | Prepaid vehicle balance (in yuan, accurate to two decimal places). |
| »» VehicleTypeNo | body | string | null | Yes | Vehicle type number | Vehicle type number. |
| »» ParkingCardTypeNo | body | string | null | Yes | License plate type number | License plate type number. |
| »» OperatorName | body | string | null | Yes | Operator name | Name of the operator. |
| »» Remarks | body | string | null | Yes | Remarks information | Remarks information. |
| »» EnableOffline | body | integer | Yes | Whitelist enable | Automatic gate opening when camera is offline (whitelist): 0 - Disabled, 1 - Enabled. |
| »» IsDeleteOwner | body | boolean | Yes | Whether to delete owner information | When performing delete operation, whether to also delete owner information. Note: deleting owner information will also delete all associated vehicle information. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"NoticeType": 0,
"Items": [
{
"No": "630000201108254378",
"LicensePlateNumber": "P12345",
"ParkingSpotNumber": "56",
"OwnerParkingSpaceCount": 2,
"OwnerName": "ces",
"OwnerNo": "410000199701311192",
"OwnerIDCard": "",
"OwnerLicense": "test",
"OwnerAddress": "",
"PhoneNumber": "",
"Email": "",
"StartTime": "2024-02-27 11:04:31",
"EndTime": "2026-12-27 11:04:31",
"StoredVehicleBalance": 0,
"VehicleTypeNo": "1772492942395203",
"ParkingCardTypeNo": "1772492942389944",
"OperatorName": "",
"Remarks": "",
"EnableOffline": 1,
"IsDeleteOwner": false
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774678624879",
"Nonce": "1t3ypa7wchrn",
"Sign": "pkuxyeck2mm8v4na9voqee+il3mo5xdvbirjwt34qe4="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Add or update operation successfully!",
"ResultId": "2037775965145300992"
}Notify Blacklist Changes (Including Add, Edit, Delete)
Brief Description
- This API is used to manage the addition, update, and deletion of blacklist records.
Request URL
http://localhost:8888/Api/V2/OpenApi/Notice
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | BlackList | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » NoticeType | body | integer | Yes | Notification type | Notification type: 0 - Add or Update, 1 - Delete. |
| » Items | body | [object] | Yes | Notification data collection | Collection of notification data |
| »» No | body | string | Yes | Record number | Unique number for the current record. |
| »» LicensePlateNumber | body | string | null | Yes | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» OwnerName | body | string | null | Yes | Owner name | Name of the vehicle owner recorded in the blacklist record. |
| »» PhoneNumber | body | string | null | Yes | Phone number | Phone number. |
| »» StartTime | body | string | null | Yes | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | body | string | null | Yes | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | body | string | null | Yes | Remarks information | Remarks information. |
| »» CreationTime | body | string | null | Yes | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | body | string | null | Yes | Operator name | Name of the operator. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"NoticeType": 0,
"Items": [
{
"No": "1234567890",
"LicensePlateNumber": "B12345",
"OwnerName": "",
"PhoneNumber": "",
"StartTime": "2026-01-28 14:39:10",
"EndTime": "2026-03-28 14:39:10",
"Remarks": "",
"CreationTime": "2026-03-28 14:39:10",
"OperatorName": ""
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774679966590",
"Nonce": "ofmdq0shb7xr",
"Sign": "j7tr3+laeqxgc7ubygekl95tzgzct+f8ut4qsmsb7ik="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Add or update operation successfully!",
"ResultId": "2037781592655560704"
}Notify Plate Coupon Record Changes (Including Add, Edit, Delete)
Brief Description
- This API is used to notify the software to add, update, or delete plate coupons.
Request URL
http://localhost:8888/Api/V2/OpenApi/Notice
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | PlateCoupon | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » NoticeType | body | integer | Yes | Notification type | Notification type: 0 - Add or Update, 1 - Delete. |
| » Items | body | [object] | Yes | Notification data collection | Collection of notification data |
| »» No | body | string | Yes | Record number | Unique number for the current record. |
| »» CouponSchemeNo | body | string | Yes | Coupon scheme number | Coupon scheme number. |
| »» Type | body | string | Yes | Coupon discount type | Coupon discount type (101 - Discount amount, 102 - Discount duration, 103 - Discount ratio, 104 - Free until specified time) |
| »» Value | body | number | Yes | Discount value | For discount amount: the amount in yuan. |
| »» StartTime | body | string | null | Yes | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» EndTime | body | string | null | Yes | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OrderNo | body | string | null | Yes | Parking order | Unique parking order created when the vehicle enters. |
| »» LicensePlateNumber | body | string | null | Yes | License plate number | License plate number (Note: when input, all letters are converted to uppercase by default). |
| »» BusinessName | body | string | Yes | Merchant name | Merchant name. |
| »» CreationTime | body | string | Yes | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Remarks | body | string | null | Yes | Remarks information | Remarks information. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"NoticeType": 0,
"Items": [
{
"No": "32000020140129785X",
"CouponSchemeNo": "test",
"Type": "101",
"Value": 10,
"StartTime": "2026-03-28 14:42:35",
"EndTime": "2026-03-28 14:42:35",
"OrderNo": "1668010507727935-B12345",
"LicensePlateNumber": "B12345",
"BusinessName": "test",
"CreationTime": "2026-03-28 14:42:35",
"Remarks": "test"
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774680172647",
"Nonce": "enu5putm0vyf",
"Sign": "vn2tmadrbhgu773/kayfr9kabunwb5kqasxbm55vwca="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Add or update operation successfully!",
"ResultId": "2037782456908677120"
}Notify Coupon Scheme Changes (Including Add, Edit, Delete)
Brief Description
- This API is used to manage the addition, deletion, and modification of coupon schemes.
Request URL
http://localhost:8888/Api/V2/OpenApi/Notice
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Query Parameters
| Parameter | Type | Example Value | Description |
|---|---|---|---|
| Route | string | CouponScheme | API route |
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » NoticeType | body | integer | Yes | Notification type | Notification type: 0 - Add or Update, 1 - Delete. |
| » Items | body | [object] | Yes | Notification data collection | Collection of notification data |
| »» No | body | string | Yes | Record number | Unique number for the current record. |
| »» Name | body | string | null | Yes | Coupon scheme name | Coupon scheme name. |
| »» Type | body | string | null | Yes | Coupon discount type | Coupon discount type (101 - Discount amount, 102 - Discount duration, 103 - Discount ratio, 104 - Free until specified time) |
| »» Amount | body | number | null | Yes | Discount amount (for amount type) | Discount amount for amount type (unit: yuan). |
| »» Duration | body | number | Yes | Discount duration (for duration type) | Discount duration for duration type (unit: minutes). |
| »» Ratio | body | number | Yes | Discount ratio (for ratio type) | Discount ratio for ratio type. |
| »» VaildTime | body | string | Yes | Free until specified time | Free until specified time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» Enable | body | integer | Yes | Whether coupon scheme is enabled | Whether coupon scheme is enabled: 0 - Disabled, 1 - Enabled. |
| »» Scene | body | integer | Yes | Coupon scheme usage scene | Coupon scheme usage scene: 0 - Only for in-field discount, 1 - Only for exit discount, 2 - Exit and in-field discount. |
| »» CreationTime | body | string | Yes | Creation time | Creation time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| »» OperatorName | body | string | null | Yes | Operator name | Name of the operator. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"NoticeType": 0,
"Items": [
{
"No": "710000197308123736",
"Name": "test",
"Type": "101",
"Amount": 10,
"VaildTime": "2026-03-28 14:45:09",
"Enable": 1,
"Scene": 1,
"CreationTime": "2026-03-28 14:45:09"
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774680383712",
"Nonce": "vw68p8xvrpdm",
"Sign": "8dicgrq2fyvczw4hygktnoapaycjthehtlemxzozfl8="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Add or update operation successfully!",
"ResultId": "2037783342175256576"
}Notify Control Lane Barrier Status (Including Release, Close,Normally Release,Cancel Normally Release)
Brief Description
- This API is used to notify and control the lane barrier gate status.
Request URL
http://localhost:8888/Api/V2/OpenApi/SetLaneGateStatus
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » LaneNo | body | string | Yes | Lane number | Lane number |
| » Status | body | integer | Yes | Set barrier gate status | Set barrier gate status: 0 - Close gate, 1 - Open gate, 2 - Control constant open (if the gate is already in constant open state, sending this command will cancel constant open). |
| » OperatorName | body | string | null | Yes | Operator name | Name of the operator. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"LaneNo": "2",
"Status": 1
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774680773498",
"Nonce": "qx04njd4zmxl",
"Sign": "k2nuvwcw9lkcrnaiwz+gqyxexwo2wt7cfrdfksbxfua="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "[Exit Camera]Release gate successfully!",
"ResultId": "2037784977043652608"
}Notify Lane Popup Order Fee Modification
Brief Description
- This API is used to modify the exit fee for a license plate by a third-party platform when the vehicle owner requests assistance from the platform after vehicle recognition.
- The modified amount must be less than the amount displayed in the lane popup window.
Request URL
http://localhost:8888/Api/V2/OpenApi/ModifyLaneOrderMoney
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » OrderNo | body | string | null | Yes | Parking order | Unique parking order created when the vehicle enters. |
| » LaneNo | body | string | Yes | Lane number | Lane number. |
| » Money | body | integer | Yes | Amount to modify the lane fee to | Amount to modify the lane fee to (unit: cents). |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"OrderNo": "1774695602882864-BCDE11",
"LaneNo": "2",
"Money": 10
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774683226943",
"Nonce": "v9hilqn7bkr7",
"Sign": "lll4iggtxxuowa1ox65h9fsa0fm7be8s6nmdmvdevcc="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Update payment amount successfully!",
"ResultId": "2037795267470721024"
}Notify Vehicle Payment Information
Brief Description
- This API is used to send payment notification information to the system.
- After receiving the notification, the exit lane will open the gate.
- Note: Payment order numbers cannot be duplicated. If a duplicate order number is received, the system will return a message indicating that the payment order is already being processed.
Request URL
http://localhost:8888/Api/V2/OpenApi/PaySuccess
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » OrderNo | body | string | Yes | Parking order | Unique parking order created when the vehicle enters. |
| » TotalAmountDue | body | number | Yes | Total amount due | Total amount due (in yuan, accurate to two decimal places). |
| » TotalAmountPaid | body | number | Yes | Total amount paid | Total amount paid (in yuan, accurate to two decimal places). |
| » DiscountAmount | body | number | Yes | Discount amount | Discount amount (in yuan, accurate to two decimal places). |
| » PaymentTime | body | string | Yes | Payment time | Payment time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| » PaymentMethod | body | string | Yes | Payment method number | For details, refer to the type enumeration/payment method enumeration information. |
| » PaymentOrderNo | body | string | Yes | Payment order number | Payment order number. |
| » Remarks | body | string | null | Yes | Remarks information | Remarks information. |
| » PlateCouponNos | body | [object] | Yes | Collection of used license plate coupons | Collection of used license plate coupons. |
| »» No | body | string | Yes | Coupon number | Coupon number. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"OrderNo": "1774695602882864-BCDE11",
"TotalAmountDue": 5,
"TotalAmountPaid": 5,
"DiscountAmount": 0,
"PaymentTime": "2026-03-28 15:57:36",
"PaymentMethod": "79024",
"PaymentOrderNo": "521774684656270152"
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774684701374",
"Nonce": "nhrqcaxymc9c",
"Sign": "vaimlh60+n6sf3hghy/ps53z4wgzpjbc/0iwuhahzbo="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Payment successfully!",
"ResultId": "2037801451640619008"
}Create Entry Order for Vehicle Without Plate
Brief Description
- This API is used to create an entry record for vehicles without a license plate upon entry and return the parking order number.
Request URL
http://localhost:8888/Api/V2/OpenApi/CreateNoPlate
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » LicensePlateNumber | body | string | Yes | License plate number | Virtual license plate number for license-plate-less vehicle entry, preferably not a real license plate. |
| » EntryTime | body | string | Yes | Entry time | Entry time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| » VehicleTypeNo | body | string | null | Yes | Vehicle type number | Vehicle type number. |
| » ParkingCardTypeNo | body | string | Yes | License plate type number | License plate type number. |
| » LaneNo | body | string | Yes | Entry lane number | Entry lane number. |
| » OperatorName | body | string | null | Yes | Operator name | Name of the operator. |
| » Remarks | body | string | null | Yes | Remarks information | Remarks information. |
Request Example
{
"ParkKey": "{{parkkey}}",
"AppId": "{{appid}}",
"TimeStamp": "{{timestamp}}",
"Nonce": "okulfmutapcl",
"Sign": "uxhrbhycphdtruhvlqosicvc",
"Data": {
"LicensePlateNumber": "A887755",
"EntryTime": "2024-02-27 14:06:46",
"VehicleTypeNo": "1708773681734708",
"ParkingCardTypeNo": "1708773681731663",
"LaneNo": "1",
"Remarks": "This is a prominent remark"
}
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
| » OrderNo | string | null | true | Parking order | Unique parking order created when the vehicle enters. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "License-plate-less vehicle entry confirmed successfully (gate opened)!",
"ResultId": "1762358795399364608",
"Data": {
"OrderNo": "1762358795516805120-A887755"
}
}Notify Callback Parameter Changes
Brief Description
- This API is used to modify callback parameters.
- The
Indexfield in theDataarray corresponds to the sequence number in the callback interface enumeration. Please configure the interfaces that require callbacks according to your needs. Sequence numbers not included in the array will default to no callback. Similarly, an empty URL address will also default to no callback. For interface security specifications, please refer to the API authentication documentation.
Request URL
http://localhost:8888/Api/V2/OpenApi/SetCallbackParams
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | [object] | Yes | Specific data | Data sent by the API, in string format. |
| » Index | body | integer | No | Callback interface enumeration sequence number | For details, refer to the type enumeration/callback interface enumeration. |
| » Url | body | string | No | Callback interface URL | The callback address for this enumeration sequence interface. If not filled, the callback will not be enabled. |
| » Interval | body | integer | Yes | Callback data processing interval | Callback data processing interval, unit: milliseconds. Must be ≥200ms and ≤600000ms (10 minutes). |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": [
{
"Index": 4,
"Url": "http://192.168.22.247:8080",
"Interval": 1000
}
],
"ParkKey": "1772492942362538",
"TimeStamp": "1774688483419",
"Nonce": "50urf7owudi4",
"Sign": "ja2bc5hozy6lw5fwldr8e0u/7d5cacmb7nc9hrb0lso="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successfully",
"ResultId": "2037817314582233088"
}Notify Failed Callback Business Retry
Brief Description
- Calling this API triggers the parking local open API service to re-push callback business that failed within the specified date range.
- This API can be called only once every 30 minutes.
Request URL
http://localhost:8888/Api/V2/OpenApi/RetryCallback
Request Method
- POST
Request Content-Type
application/json
Request Parameters
Body Parameters
| Parameter | Location | Type | Required | Description | Notes |
|---|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID | Local parking lot identifier |
| AppId | body | string | Yes | Application Service Identifier | Local application service identifier for the parking lot |
| TimeStamp | body | string | Yes | Timestamp | 13-digit timestamp in milliseconds |
| Nonce | body | string | Yes | Random String | Randomly generated string |
| Sign | body | string | Yes | API Signature | Signature generated according to API authentication rules |
| Data | body | object | Yes | Payload | Data object specific to this API |
| » StartTime | body | string | null | Yes | Start time | Start time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| » EndTime | body | string | null | Yes | End time | End time, following the date format in basic rules, accurate to seconds (e.g., 2023-08-01 09:34:51). |
| » RefreshTypes | body | [object] | No | Callback types to retry | Refer to the sequence numbers in the type enumeration/callback interface enumeration. If empty, all callback types will be retried. |
| »» Index | body | integer | Yes | Callback interface enumeration sequence number | For details, refer to the type enumeration/callback interface enumeration. |
Request Example
{
"AppId": "xb5glg0hgz40",
"Data": {
"StartTime": "2026-03-28 16:06:28",
"EndTime": "2026-03-28 17:06:28",
"RefreshTypes": [
{
"Index": 1
}
]
},
"ParkKey": "1772492942362538",
"TimeStamp": "1774688790638",
"Nonce": "6af6hvfw93b1",
"Sign": "7nyutdsajan+ffrftxibj+kej8rvajgq0zslcxond+4="
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Re-pull failed callback business data successfully 0",
"ResultId": "2037818603147919360"
}6. Callback Interfaces(V2.0&V3.0)
Vehicle Entry Callback
Brief Description
- Specification for the vehicle entry event notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}},http://localhost:8888/API/V2/OnVehicleIn`
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Request Content-Type
application/json
Callback Parameter Description
| Parameter | Type | Name | Required | Description | Note |
|---|---|---|---|---|---|
| ParkKey | body | string | yes | Parking Lot Key | Local parking lot identifier |
| AppId | body | string | yes | App Service ID | Local parking app service identifier |
| TimeStamp | body | string | yes | Timestamp | 13-digit timestamp, accurate to milliseconds |
| Nonce | body | string | yes | Nonce String | Random string |
| Sign | body | string | yes | API Signature | Signature generated according to API authentication |
| Data | body | object | yes | Data Detail | Data object corresponding to the API request |
| » OrderNo | body | string | yes | Parking Order No. | Unique parking order created on vehicle entry |
| » LicensePlateNumber | body | string | yes | License Plate Number | Converted to uppercase by default |
| » EntryTime | body | string | yes | Entry Time | Format: yyyy-MM-dd HH:mm:ss |
| » LicensePlateColor | body | integer | yes | License Plate Color Code | Refer to license plate color enum |
| » EntryLaneNo | body | string | yes | Entry Lane No. | Entry lane number |
| » EntryLaneName | body | string | yes | Entry Lane Name | Entry lane name |
| » EntryOperatorName | body | string | yes | Entry Operator | Entry operator name |
| » VehicleTypeNo | body | string | yes | Vehicle Type No. | Vehicle type code |
| » VehicleTypeName | body | string | yes | Vehicle Type Name | Vehicle type name |
| » ParkingCardTypeNo | body | string | yes | Plate Type No. | Plate type code |
| » ParkingCardTypeName | body | string | yes | Plate Type Name | Plate type name |
| » ReserveOrderNo | body | string¦null | yes | Reservation Order No. | Available if the vehicle is a reservation vehicle |
| » ParkingAreaNo | body | string | yes | Parking Area No. | Current parking area code |
| » ParkingAreaName | body | string | yes | Parking Area Name | Current parking area name |
| » EntryImageUrl | body | string¦null | yes | Entry Image URL | Cloud storage URL if cloud image storage is enabled |
| » EntryImageBase64 | body | string¦null | yes | Entry Image Base64 | Base64 of entry image; excluded from signature |
Request Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"OrderNo": "1774718489366642-6Y8MT1",
"LicensePlateNumber": "76Y8MT1",
"EntryTime": "2026-03-28 17:21:27",
"LicensePlateColor": 1,
"EntryLaneNo": "1",
"EntryLaneName": "Entrance Lane",
"EntryOperatorName": "qq",
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"ParkingAreaNo": "1772492942540835",
"ParkingAreaName": "Outer Field",
"EntryImageUrl": "",
"EntryImageBase64": ""
},
"Sign": "zngg3e7rcch9dst41oaem9j+pmvulcdpdbflrghegoy=",
"TimeStamp": "1774689712754",
"Nonce": "2037822471420280832",
"RequestId": "2037822471407697920"
}Return Parameter Description
| Parameter | Type | Required | Description | Remarks |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default. |
| ResultMsg | string | true | Request message | Information message returned by the API. |
| ResultId | string | true | Request response identifier | Unique identifier for this request processing. |
| Data | object | null | false | Response data | Data object returned by the API. |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful",
"ResultId": 500303426998439
}Vehicle Exit Callback
Brief Description
- Specification for the vehicle exit event notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnVehicleOut
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » OrderNo | body | string | null | Yes | Parking order |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » ExitTime | body | string | null | Yes | Exit time |
| » LicensePlateColor | body | integer | Yes | License plate color sequence number |
| » ExitLaneNo | body | string | null | Yes | Exit lane number |
| » ExitLaneName | body | string | null | Yes | Exit lane name |
| » ExitOperatorName | body | string | null | Yes | Exit operator |
| » VehicleTypeNo | body | string | null | Yes | Vehicle type number |
| » VehicleTypeName | body | string | null | Yes | Vehicle type name |
| » ParkingCardTypeNo | body | string | null | Yes | License plate type number |
| » ParkingCardTypeName | body | string | null | Yes | License plate type name |
| » ParkingAreaNo | body | string | Yes | Parking area number |
| » ParkingAreaName | body | string | null | Yes | Parking area name |
| » ExitImageUrl | body | string | null | Yes | Exit passage capture image URL |
| » ExitImageBase64 | body | string | null | Yes | Exit passage capture image |
| » TotalAmountDue | body | number | Yes | Total amount due |
| » TotalAmountPaid | body | number | Yes | Total amount paid |
| » IsFreePass | body | boolean | Yes | Whether free pass is granted |
| » FreePassReason | body | string | null | Yes | Free pass reason |
| » Remarks | body | string | null | Yes | Remarks information |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"OrderNo": "1774718489366642-6Y8MT1",
"LicensePlateNumber": "76Y8MT1",
"ExitTime": "2026-03-28 17:28:26",
"LicensePlateColor": 1,
"ExitLaneNo": "2",
"ExitLaneName": "Exit Lane",
"ExitOperatorName": "qq",
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"ParkingAreaNo": "1772492942540835",
"ParkingAreaName": "Outer Field",
"ExitImageUrl": "",
"ExitImageBase64": "",
"TotalAmountDue": 5,
"TotalAmountPaid": 5,
"IsFreePass": false
},
"Sign": "asoekfeybydqgmhxxchhn8jraddnzfcls2+zdtwh5zk=",
"TimeStamp": "1774690115822",
"Nonce": "2037824162010005504",
"RequestId": "2037824161997422592"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Payment Result Callback
Brief Description
- Specification for the payment result callback notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, example: http://localhost:8888/API/V2/OnPayResult
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » OrderNo | body | string | null | Yes | Parking order |
| » PaymentOrderNo | body | string | Yes | Payment order number |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » TotalAmountDue | body | number | Yes | Total amount due |
| » TotalAmountPaid | body | number | Yes | Total amount paid |
| » DiscountAmount | body | number | Yes | Discount amount |
| » PaymentTime | body | string | Yes | Payment time |
| » PaymentMethod | body | string | Yes | Payment method number |
| » PayScene | body | integer | Yes | Payment scene |
| » VehicleTypeNo | body | string | null | Yes | Vehicle type number |
| » VehicleTypeName | body | string | null | Yes | Vehicle type name |
| » ParkingCardTypeNo | body | string | null | Yes | License plate type number |
| » ParkingCardTypeName | body | string | null | Yes | License plate type name |
| » Remarks | body | string | null | Yes | Remarks information |
| » ParkingDuration | body | integer | Yes | Parking duration |
| » StoredValueDeduction | body | number | No | Prepaid vehicle deduction amount |
| » OperatorName | body | string | null | Yes | Operator name |
| » CouponUsageList | body | [object] | No | Coupon usage list |
| »» No | body | string | Yes | Used coupon number |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"OrderNo": "1774718489366642-6Y8MT1",
"PaymentOrderNo": "PO1774718907646185",
"LicensePlateNumber": "76Y8MT1",
"TotalAmountDue": 5,
"TotalAmountPaid": 5,
"DiscountAmount": 0,
"PaymentTime": "2026-03-28 17:28:27",
"PaymentMethod": "79001",
"PayScene": 0,
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389506",
"ParkingCardTypeName": "Temporary Car A",
"ParkingDuration": 6,
"StoredValueDeduction": 0,
"OperatorName": "qq"
},
"Sign": "z3nbuv83rzxsjrmd0+6lkz97ntrrpjl7rgpnh+0ltco=",
"TimeStamp": "1774690112810",
"Nonce": "2037824149376761856",
"RequestId": "2037824149339013120"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Vehicle Issuance Callback
Brief Description
- Specification for the vehicle subscription notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnSubscribedVehicle
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » OwnerNo | body | string | null | Yes | Owner number |
| » OwnerName | body | string | null | Yes | Owner name |
| » OwnerParkingSpaceCount | body | integer | Yes | Owner’s parking space count |
| » StartTime | body | string | null | Yes | Start time |
| » EndTime | body | string | null | Yes | End time |
| » StoredVehicleBalance | body | number | Yes | Prepaid vehicle balance |
| » VehicleTypeNo | body | string | null | Yes | Vehicle type number |
| » VehicleTypeName | body | string | null | Yes | Vehicle type name |
| » ParkingCardTypeNo | body | string | null | Yes | License plate type number |
| » ParkingCardTypeName | body | string | null | Yes | License plate type name |
| » CreationTime | body | string | Yes | Creation time |
| » ResidentialAddress | body | string | Yes | Residential address |
| » PhoneNumber | body | string | Yes | Phone number |
| » Remarks | body | string | null | Yes | Remarks information |
| » OperatorName | body | string | null | Yes | Operator name |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"LicensePlateNumber": "Q1234",
"PaymentOrderNo": "MC1774721023079330",
"TotalAmountDue": 0,
"TotalAmountPaid": 0,
"DiscountAmount": 0,
"PaymentMethod": "79001",
"PaymentTime": "2026-03-28 18:03:43",
"OperatorName": "qq",
"StartTime": "2026-03-28 00:00:00",
"EndTime": "2026-04-27 23:59:59",
"StoredVehicleBalance": 0,
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389944",
"ParkingCardTypeName": "Monthly Rental Car A"
},
"Sign": "f0nbrmh+bdhm5y2g0odk6byqhayzpvet2cwvhoq0gfq=",
"TimeStamp": "1774692234475",
"Nonce": "2037833048284758016",
"RequestId": "2037833048217649152"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Vehicle Cancellation Callback
Brief Description
- Specification for the vehicle unsubscription notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnUnsubscribedVehicle
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » OperatorName | body | string | null | Yes | Operator name |
| » OperationTime | body | string | Yes | Operation time |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"LicensePlateNumber": "Q1234",
"OperatorName": "",
"OperationTime": "2026-03-28 18:07:11"
},
"Sign": "o8uggl5yd0tswjdnq1ezp1jx+bwhlh5ztlulqtdvis8=",
"TimeStamp": "1774692458704",
"Nonce": "2037833988769349633",
"RequestId": "2037833988769349632"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Vehicle Recharge and Extension Callback
Brief Description
- Specification for the vehicle recharge and extension notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnRechargeGracePeriod
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » PaymentOrderNo | body | string | Yes | Payment order number |
| » TotalAmountDue | body | number | Yes | Total amount due |
| » TotalAmountPaid | body | number | Yes | Total amount paid |
| » DiscountAmount | body | number | Yes | Discount amount |
| » PaymentMethod | body | string | Yes | Payment method number |
| » PaymentTime | body | string | Yes | Payment time |
| » OperatorName | body | string | null | Yes | Operator name |
| » StartTime | body | string | null | Yes | Start time |
| » EndTime | body | string | null | Yes | End time |
| » StoredVehicleBalance | body | number | Yes | Prepaid vehicle balance |
| » VehicleTypeNo | body | string | null | Yes | Vehicle type number |
| » VehicleTypeName | body | string | null | Yes | Vehicle type name |
| » ParkingCardTypeNo | body | string | null | Yes | License plate type number |
| » ParkingCardTypeName | body | string | null | Yes | License plate type name |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"LicensePlateNumber": "P12345",
"PaymentOrderNo": "MC17747215714999401772492942362538",
"TotalAmountDue": 20,
"TotalAmountPaid": 20,
"DiscountAmount": 0,
"PaymentMethod": "79001",
"PaymentTime": "2026-03-28 18:12:51",
"OperatorName": "qq",
"StartTime": "2026-12-28 00:00:00",
"EndTime": "2027-05-01 23:59:59",
"StoredVehicleBalance": 0,
"VehicleTypeNo": "1772492942395203",
"VehicleTypeName": "Blue Plate Vehicle",
"ParkingCardTypeNo": "1772492942389944",
"ParkingCardTypeName": "Monthly Rental Car A"
},
"Sign": "3oqfkqasdhj9jnypuh+etwdfl0j5efvqnsml96gzmdi=",
"TimeStamp": "1774692776940",
"Nonce": "2037835323547877376",
"RequestId": "2037835323468185600"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Gate Release Record Callback
Brief Description
- Specification for the gate release record notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnGateReleaseRecord
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » No | body | string | Yes | Record number |
| » OrderNo | body | string | null | Yes | Parking order |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » PassageTime | body | string | Yes | Passage time |
| » Remarks | body | string | null | Yes | Remarks information |
| » ImageBase64 | body | string | Yes | Image Base64 |
| » InOutType | body | integer | Yes | Lane entry/exit type |
| » PassageLaneNo | body | string | Yes | Passage lane number |
| » PassageLaneName | body | string | Yes | Passage lane name |
| » OperatorName | body | string | null | Yes | Operator name |
| » AbnormalPassType | body | integer | Yes | Abnormal passage type |
Callback Parameter Example
{
"ParkKey":"1708773681705596",
"AppId":"p226uwb3",
"TimeStamp":"1709018037090",
"Data":{
"No":"1709046823138325",
"OrderNo":null,
"LicensePlateNumber":null,
"PassageTime":"2024-02-27 15:13:39",
"Remarks":"[Exit Camera] Gate opened successfully!",
"ImageBase64":null,
"InOutType":0,
"PassageLaneNo":"2",
"PassageLaneName":"Exit Lane",
"OperatorName":"admin",
"AbnormalPassType":6200
},
"Nonce":"1762375499496062976",
"Sign":"glbo72hyooartypvwcdct8obxkrxayjlkxvxcmtj2/8="
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Parking Space Change Callback
Brief Description
- Specification for the parking space change notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnParkingSpaces
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » TotalSpaces | body | integer | Yes | Total parking spaces in the lot |
| » RemainingSpaces | body | integer | Yes | Remaining parking spaces in the lot |
| » AreaSpaces | body | [object] | Yes | Area parking space information |
| »» AreaNo | body | string | Yes | Area number |
| »» AreaName | body | string | Yes | Area name |
| »» TotalSpaces | body | integer | Yes | Total number of parking spaces |
| »» RemainingSpaces | body | integer | Yes | Number of remaining parking spaces |
| » CarCardTypeSpaces | body | [object] | Yes | License plate type parking space count |
| »» AreaCarCardTypeName | body | string | Yes | Area name + License plate type name |
| »» AreaNo | body | string | Yes | Area number |
| »» UseSpaces | body | integer | Yes | Number of occupied parking spaces |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"TotalSpaces": 500,
"RemainingSpaces": 499,
"AreaSpaces": [
{
"AreaNo": "1772492942540835",
"AreaName": "Outer Field",
"TotalSpaces": 500,
"RemainingSpaces": 499
}
],
"CarCardTypeSpaces": [
{
"AreaCarCardTypeName": "[Outer Field]Temporary Car A",
"AreaNo": "1772492942540835",
"UseSpaces": 1
}
]
},
"Sign": "w5msyfgltx69gtf5ovtfkeflvvgh+txai+1j6qitxw0=",
"TimeStamp": "1774690132438",
"Nonce": "2037824231702560768",
"RequestId": "2037824231698366464"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Blacklist Callback
Brief Description
- Specification for the blacklist change notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnBlackList
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » LicensePlateNumber | body | string | null | Yes | License plate number |
| » OwnerName | body | string | null | Yes | Owner name |
| » PhoneNumber | body | string | Yes | Phone number |
| » StartTime | body | string | null | Yes | Start time |
| » EndTime | body | string | null | Yes | End time |
| » CreationTime | body | string | Yes | Creation time |
| » OperatorName | body | string | null | Yes | Operator name |
| » Remarks | body | string | null | Yes | Remarks information |
| » Status | body | integer | Yes | Blacklist information |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"LicensePlateNumber": "B12345",
"OwnerName": "",
"PhoneNumber": "",
"StartTime": "2026-03-28 14:39:10",
"EndTime": "2026-03-28 14:39:10",
"CreationTime": "2026-03-28 14:39:10",
"Remarks": "",
"OperatorName": "OpenAPI Platform-",
"Status": 0
},
"Sign": "zgq0sdnnxahbtfkfa2v+wd1ycmzafx2ywzrztn7juiq=",
"TimeStamp": "1774693473977",
"Nonce": "2037838247132954624",
"RequestId": "2037838247120371712"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}Booth Lane Information Callback
Brief Description
- Specification for the booth lane information change notification interface.
- If this interface is not implemented, please do not enable it in the callback parameter settings to avoid unnecessary data notification operations.
- When the lane information of a booth is updated, the complete lane information will be sent to the third-party parking service.
Example URL
{{Third-party URL}}, Example URL: http://localhost:8888/API/V2/OnLaneChange
Note: This URL is the callback URL from the system to the third party, i.e., the endpoint where the third party receives data pushed by the system.
Request Method
- POST
Content Type
- Content-Type:
application/json
Callback Parameter Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ParkKey | body | string | Yes | Parking Lot ID |
| AppId | body | string | Yes | Application Service Identifier |
| TimeStamp | body | string | Yes | Timestamp |
| Nonce | body | string | Yes | Random String |
| Sign | body | string | Yes | API Signature |
| Data | body | object | Yes | Specific data |
| » SentryHostNo | body | string | Yes | Booth number |
| » Lanes | body | [object] | Yes | Booth lane information |
| »» Uid | body | integer | Yes | Record primary key |
| »» No | body | string | Yes | Record number |
| »» LaneName | body | string | null | Yes | Lane name |
| »» LaneType | body | integer | Yes | Lane type |
| »» LaneDutyMode | body | integer | Yes | Lane duty type |
| »» CameraMode | body | integer | Yes | Camera mode |
| »» IdInterval | body | integer | Yes | Camera recognition interval |
| »» IsBackCar | body | integer | null | Yes | Whether reverse vehicle detection is enabled |
| »» IsCharge | body | integer | Yes | Lane fee collection enabled |
| »» CreationTime | body | string | Yes | Creation time |
| »» IsSense | body | integer | Yes | Whether ground loop detection is enabled for license-plate-less vehicle scanning |
| »» IsSameInOut | body | integer | Yes | Whether same entry/exit mode |
| »» SameInOutLaneNo | body | string | null | Yes | Associated lane number in same entry/exit mode |
| »» SameInOutType | body | integer | Yes | Entry/exit type of lane in same entry/exit mode |
| »» IsEnableBoard | body | integer | Yes | Whether lane control board is enabled |
| »» LaneLinkAreas | body | [object] | Yes | Area information bound to the current lane |
| »»» No | body | string | Yes | Record number |
| »»» AreaNo | body | string | Yes | Associated area number |
| »»» InOutMode | body | integer | Yes | Entry/exit mode of lane in the current area |
Callback Parameter Example
{
"ParkKey": "1772492942362538",
"AppId": "xb5glg0hgz40",
"Data": {
"SentryHostNo": "1772492942363478",
"Lanes": [
{
"Uid": 1,
"No": "1",
"LaneName": "Entrance Lane",
"LaneType": 1,
"IdInterval": 3,
"IsBackCar": 0,
"IsCharge": 0,
"OpenGateAndVoice": 1,
"CreationTime": "2026-03-02 23:09:02",
"IsSense": 1,
"IsSameInOut": 0,
"SameInOutType": 0,
"IsEnableBoard": 0,
"LaneLinkAreas": [
{
"No": "1774609216714465",
"AreaNo": "1772492942540835",
"InOutMode": 1
}
]
},
{
"Uid": 2,
"No": "2",
"LaneName": "Exit Lane",
"LaneType": 1,
"IdInterval": 3,
"IsBackCar": 0,
"IsCharge": 1,
"OpenGateAndVoice": 1,
"CreationTime": "2026-03-02 23:09:02",
"IsSense": 1,
"IsSameInOut": 0,
"SameInOutType": 0,
"IsEnableBoard": 0,
"LaneLinkAreas": [
{
"No": "1774609216715573",
"AreaNo": "1772492942540835",
"InOutMode": 0
}
]
}
]
},
"Sign": "vuh/cxlb1mjf+hy+xits4ugm0g8zjdpokkz7wj5ihry=",
"TimeStamp": "1774693148730",
"Nonce": "2037836882948161536",
"RequestId": "2037836882931384320"
}Callback Return Description
| Parameter | Type | Required | Description | Notes |
|---|---|---|---|---|
| ResultCode | integer | true | Request result code | For details, refer to the result code enumeration. 200 indicates success by default |
| ResultMsg | string | true | Request message | Information message returned by the API |
| Data | object | null | false | Response data | Data object returned by the API |
Return Example
{
"ResultCode": 200,
"ResultMsg": "Operation successful"
}7. V3.0 Interface Documentation (MQTT)
All 3.0 MQTT interfaces follow the same request parameters, response structure, signature rules, and service fields as the 2.0 HTTP interface. Only the transmission method, routing identifier, and additional fields differ, as shown below.
7.1 Development Guide
- Please refer to Section 3.1 Development Guide of this document.
7.1.1 Parameter Acquisition and Configuration
Calling the API requires the use of the appid, AppSecret and ParkKey parameters. These must be configured and filled in within the System Settings. The specific steps are shown below:

Enable and configure MQTT parameters

7.1.2 Basic Rules
- Please refer to Section 3.1.2 Development Guide of this document.
7.1.3 Interface Authentication
Note:The MQTT interface uses the same signature as V2; it only adds Route and RequestId to the request parameters.
- Take the Query Zone Information interface as an example.
Note: The following example is only for demonstrating the signature calculation process. In actual use, replace it with real parameters.
- Assume the request data is as follows:
{
"ParkKey": "{{parkkey}}",
"AppId": "{{appid}}",
"TimeStamp": "{{timestamp}}",
"Nonce": "owekhjgzkosy",
"Sign": "pezgzflbnbrwwcdadjajvphz",
"Route": "AreaQuery",
"RequestId": "12345665",
"Data": {
"PageIndex": 1,
"PageSize": 25,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": [
]
}
}- Sort the content inside
Datain ASCII ascending order, then convert it to a lowercase string:
orderby=uid&ordertype=0&pageindex=1&pagesize=25&querycondition=- Encrypt the sorted data using MD5.The MD5 encrypted result of the
Datafield is:
0a78297be1cf12b1faf9efa8b74f1c5e- Concatenate the prepared parameters into a string:
AppId,ParkKey,TimeStamp,Nonce, andData.
appid=fvytu5eq&data=0a78297be1cf12b1faf9efa8b74f1c5e&parkkey=1726313394251322×tamp=1728559158205&nonce=836867- Convert the string from Step 4 to lowercase, then sign it using the HMAC-SHA256 algorithm with the third-party service
AppSecretas the secret key. The result is the required signature.
0pv/bitn6cuvogmlg8xtgniuytiealcy5fkxtgy7wci=- Add
RequestIdandRouteto the request body, then send the interface request.
{
"ParkKey": "1726313394251322",
"AppId": "fvytu5eq",
"TimeStamp": "1728559158205",
"Nonce": "836867",
"Sign": "0pv/bitn6cuvogmlg8xtgniuytiealcy5fkxtgy7wci=",
"Route": "AreaQuery",
"RequestId": "12345665",
"Data": {
"PageIndex": 1,
"PageSize": 25,
"OrderBy": "Uid",
"OrderType": 0,
"QueryCondition": []
}
}Response data:
{
"ResultCode": 200,
"ResultMsg": "Query succeeded!",
"ResultId": null,
"Data": {
"PageIndex": 1,
"PageSize": 25,
"TotalCount": 2,
"Results": [
{
"Uid": 1,
"No": "1726313394367527",
"AreaName": "Outer Field",
"AreaType": 0,
"AreaSpaceNum": 63,
"PUid": 0,
"Level": 0,
"CreationTime": "2024-10-07 14:16:36"
},
{
"Uid": 2,
"No": "1728281625923837",
"AreaName": "Inner Field",
"AreaType": 1,
"AreaSpaceNum": 500,
"PUid": 1,
"Level": 1,
"CreationTime": "2024-10-07 14:16:36"
}
]
}
}7.1.4 Type Enumeration List
- Please refer to Section 3.1.4 Development Guide of this document.
7.1.5 Sensitive Information Decryption
- Please refer to Section 3.1.5 Development Guide of this document.
7.1.6 Callback Configuration Instructions
- Please refer to Section 3.1.6 Development Guide of this document.
7.2 Interface Route & Difference Table
Note: All interfaces follow the same request parameters, response structure, and signature rules. The field difference only applies to the corresponding interface version.
| Interface Type | Interface Name | v2.0 Route Value | v3.0 Route Value | Field Difference (v3.0 vs v2.0) |
|---|---|---|---|---|
| Query | Query Zone Information | Area | AreaQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Booth Information | SentryHost | BoothQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Lane Information | Lane | LaneQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Plate Type Information | CardType | PlateTypeQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Plate Color Information | CarType | PlateColorQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Lane Ground Loop Barrier Status | – | BarrierStatusQuery | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Query | Query Lane Current Order | – | LaneOrderQuery | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Query | Query Vehicle Record | MonthlyCar | VehicleRecordQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Blacklist Records | BlackList | BlacklistQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Parking Order Records | ParkingOrder | ParkingOrderQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Payment Records | PaymentOrder | PaymentRecordQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Payment Detail Records | PaymentOrderDetail | PaymentDetailQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Gate Release Record | OpenGate | GateReleaseQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Coupon Scheme | CouponScheme | CouponSchemeQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Plate Coupon Records | PlateCoupon | PlateCouponQuery | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Query | Query Parking Fee for Specified Order | – | OrderFeeQuery | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | In-Parking Record Change Notification (Including Modify and Close) | ModifyParkingOrder | ParkingRecordNotify | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Vehicle Changes (Including Add, Edit, Delete) | MonthlyCar | VehicleChangeNotify | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Blacklist Changes (Including Add, Edit, Delete) | BlackList | BlacklistChangeNotify | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Plate Coupon Record Changes (Including Add, Edit, Delete) | PlateCoupon | PlateCouponChangeNotify | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Coupon Scheme Changes (Including Add, Edit, Delete) | CouponScheme | CouponSchemeChangeNotify | v2.0: Route in Query Parameters v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Control Lane Barrier Status (Including Release, Close,Normally Release,Cancel Normally Release) | – | BarrierStatusNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Lane Popup Order Fee Modification | – | LaneFeeModifyNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Vehicle Payment Information | – | VehiclePaymentNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | Create Entry Order for Vehicle Without Plate | – | NoPlateEntryNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Callback Parameter Changes | – | CallbackParamChangeNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
| Notification | Notify Failed Callback Business Retry | – | FailedCallbackRetryNotify | v2.0: Route is none v3.0: Route + RequestId in Body Parameters |
最后编辑:mry 更新时间:2026-03-30 16:49