LPR Integration API Specification

This document outlines the API for integrating License Plate Recognition systems with the enforcifyPRO platform.

Base URL

The base URL for all endpoints is dynamic. Use the full URLs provided in each example request.

1. Authentication Endpoint

Obtain a bearer token for API authentication using OAuth2 Password Grant flow.

Request Details

HTTP Method: POST
Endpoint: /lprApiToken
Content-Type: application/x-www-form-urlencoded

Body Parameters

Name	Type	Description	Required
grant_type	string	Must be "password"	Yes
username	string	API username provided by enforcifyPRO	Yes
password	string	API password provided by enforcifyPRO	Yes

Example Request

curl -X POST https://app.enforcify.pro/functions/lprApiToken \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=password&username=YOUR_USERNAME&password=YOUR_PASSWORD"

Response (200 OK):
{
  "access_token": "bearer_1672522500000_a1b2c3d4e5f6...",
  "token_type": "bearer",
  "expires_in": 7200
}

2. LPR Data Submission Endpoint

Submit license plate recognition data for violation processing.

Request Details

HTTP Method: POST
Endpoint: /lprSubmit
Authorization: Bearer <access_token>
Content-Type: application/json

Body Parameters

Name	Type	Description	Required
event_id	string	Unique identifier for the LPR event (e.g., UUID format).	Yes
read_id	string	Unique identifier for the LPR read (e.g., UUID format).	Yes
result	integer	Code of the enforcement rule. (0: Not Paid, 1: Permit Overstay, 2: Parking Overstay, 3: Not Allowed)	Yes
license_plate	string	The detected license plate number.	Yes
timestamp	string	Time of the LPR read in "HH:MM:SS DD.MM.YYYY" format.	Yes
entry_time	string	Time of vehicle entry in "HH:MM:SS DD.MM.YYYY" format.	No
exit_time	string	Time of vehicle exit in "HH:MM:SS DD.MM.YYYY" format.	No
location	string	Location identifier (e.g., "1000100").	Yes
gps	string	GPS coordinates in "latitude,longitude" format.	Yes
images	array	List of image objects associated with the LPR event. Each object in the array must contain a "type" (e.g., "Patch", "IR", "OV") and "image" (Base64-encoded string).	Yes

Example Request

curl -X POST https://app.enforcify.pro/functions/lprSubmit \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your_access_token>" \
  -d '{
    "event_id": "AE67B732-EA19-4792-9D1C-15DE4154DA9D",
    "read_id": "F68BF460-8C27-40FF-B0BD-516F25C868E7",
    "result": 0,
    "license_plate": "TEST123",
    "timestamp": "12:34:56 28.02.2025",
    "entry_time": "12:02:36 28.02.2025",
    "exit_time": "12:34:56 28.02.2025",
    "location": "1000100",
    "gps": "-37.842341,145.286716",
    "images": [
      {
        "type": "Patch",
        "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE..."
      },
      {
        "type": "OV",
        "image": "data:image/jpeg;base64,/9j/hLMxkaejuwz..."
      }
    ]
  }'

Response (201 Created):
{
  "message": "Violation created successfully.",
  "violationId": "68ccb1d0f99aef8ffa3f4a5b"
}