ANPR ITSAPI Integration

ITSAPI (Intelligent Traffic System API) is a push-based event interface used by IC Realtime ANPR cameras to send real-time metadata to an external system for third-party integration.

Metadata may include license plate text, vehicle attributes, camera information, and event timestamps.

ITSAPI is HTTP/HTTPS-based and sends structured JSON data over the network. A listening server must be in place to receive and respond to these requests.

 

Table of Contents

1. Prerequisites and Notes
2. Setup and Configuration

---

Prerequisites and Notes

• An IC Realtime ANPR camera with ITSAPI features. Cameras that support this feature will list ITSAPI on the data sheet under Interoperability. 
• ANPR camera already configured and capturing plate data
• A server that can accept and reply to HTTP/HTTPS requests.

Notes: IC Realtime does not provide assistance with deploying, configuring, or troubleshooting customer-side servers or applications.  functioning server that can accept inbound HTTP/HTTPS requests must be fully deployed and tested before configuring ITSAPI on the camera.

Support is limited to confirming camera-side configuration options only.

ITSAPI uses a persistent HTTP/HTTPS connection. The camera maintains the connection and sends event data and periodic heartbeat messages over the same session. The connection does not close after a single event.

The camera also expects a response of {"Result":true} when the server receives the ITSAPI event.

---

Setup and Configuration

Access the ITSAPI interface by logging into the camera's IP address and navigating to Settings -> Network Settings -> Platform Access -> ITSAPI then enable the feature.

ITSAPI Camera Interface

Basic

The basic section is for server connection and data structure. Most of these settings can be left default.

1. Authentication (Optional): ITSAPI supports HTTP Digest authentication only. Basic authentication is not supported. The receiving server must explicitly support Digest authentication if enabled.
2. Platform Server: Input your server's IP address with the listening port.
3. Keep Alive Interval: Default at 300s. Recommended to leave at default.
4. Upload Picture: Choose All, Data, or Picture. All will send both text and images, Data is text only, and Picture is only pictures.
5. Heartbeat Interface: Recommended to leave default. 
6. ANPR Info Interface: Recommended to leave default.
7. Device ID: Recommended to leave default.
8. Max Keep-alive Req: Recommended to leave default.

Data Acquisition

Data acquisition has two subsections, data type and uploading info. At least one Data Type option must be enabled or no metadata will be sent. Uploading info is for plate metadata. Enable only the text-based information you want to receive.

1. Data Type
   1. Device Basic Info - Required for camera metadata information, e.g. camera model.
   2. ANPR Info - Required for any license plate metadata, e.g. alpha-numeric plate number, vehicle color, etc. 
   3. Open - Required for barrier control metadata, e.g. when a gate gets opened or closed.
2. Uploading Info
   1. Plate No - Alpha-numeric plate data.
   2. Vehicle Color - Color of the detected vehicle.
   3. Logo - Vehicle Manufacturer (not recommended as this can be inconsistent).
   4. Vehicle Type - Type of vehicle, e.g. SUV or sedan (not recommended as this can be inconsistent).
   5. ANPR Direction - Arriving or departing per the ANPR configuration.
   6. Time - Event timestamp.
   7. Location - Not currently supported with available models. Recommended to leave off.
   8. Accuracy - Accuracy estimate presented as a percentage.
   9. Vehicle in Blocklist - Boolean value that says true or false if vehicle plate has been added to blocklist.

Image Config

Image config controls what images will be included with the payload. You can choose not to use this by setting Upload Data from the Basic section to Data. 

Important: Even when Upload Data is set to Data Only, At least one image type must remain enabled or no payload will be sent.

1. Filter Condition
   1. Unlicensed Vehicle - Will still provide a snapshot if it cannot determine the license plate of a vehicle
2. Uploading Info
   1. Original Image - Complete snapshot of the image.
   2. Plate cutout - Snapshot of just the license plate. 
   3. Vehicle Body Cutout - Snapshot of just the vehicle without the complete image.
3. Encode - Recommended to leave as UTF-8