🇹🇭API Documentation for Thai LPR

Postman Example:

https://www.getpostman.com/collections/6c040f0d4770a27b84a4

1. (On-Cloud, On-Premise) Image License Plate Recognition

On Cloud - one request at a time.
On Premise - unlimited requests.
API sends external requests to the LPR system.

Input Image (Sample)

Post Image

POST https://api.iapp.co.th/license-plate-recognition/file

This endpoint allows you to send a picture that consists of minimum one vehicle that OCR must be performed. The Response will be the licence plate number of the vehicle(s) on the picture.

Headers

Request Body

{
    "conf": 94.56048584,
    "infer_time(s)": 0.1770620346069336,
    "is_missing_plate": "no",
    "is_vehicle": "yes",
    "lp_number": "6กผ40",
    "message": "success",
    "province": "th-10:Bangkok (กรุงเทพมหานคร)",
    "status": 200,
    "vehicle_body_type": "sedan-compact",
    "vehicle_brand": "nissan",
    "vehicle_color": "white",
    "vehicle_model": "nissan_sentra",
    "vehicle_orientation": "0",
    "vehicle_year": "2015-2019"
}

{    
    "message": "Couldn't recognize the license plate"
    "status": 404   
}

{    
    "message": "File Extension is not allowed"
    "status": 415   
}

This endpoint allows you to send a picture that consists of minimum one vehicle that OCR must be performed. The Response will be the licence plate number of the vehicle(s) on the picture.

Response Explanation

Sample Response

{
    "conf": 94.56048584,
    "infer_time(s)": 0.1770620346069336,
    "is_missing_plate": "no",
    "is_vehicle": "yes",
    "lp_number": "6กผ40",
    "message": "success",
    "province": "th-10:Bangkok (กรุงเทพมหานคร)",
    "status": 200,
    "vehicle_body_type": "sedan-compact",
    "vehicle_brand": "nissan",
    "vehicle_color": "white",
    "vehicle_model": "nissan_sentra",
    "vehicle_orientation": "0",
    "vehicle_year": "2015-2019"
}

{    
    "message": "Couldn't recognize the license plate"
    "status": 404   
}

{    
    "message": "File Extension is not allowed"
    "status": 415   
}


{    
    "message": "Attach one image at a time"
    "status": 462   
}


{    
    "message": "Method is not allowed",
    "status": 415   
}

Sample Request

import requests

url = "https://api.iapp.co.th/license-plate-recognition/file"
path = "path/to/your/input/image"
file_name = "your input image name"

payload={}
files=[
  ('file_name',(path, 'rb'), 'image/jpeg'))
]
headers = {
  'apikey': '----Your API Key----'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

curl --location --request POST 'https://api.iapp.co.th/license-plate-recognition/file' \
--header 'apikey: ----Your API Key----' \
--form 'your input image name=@"/path/to/your/input/image.jpg|jpeg|png"'

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://api.iapp.co.th/license-plate-recognition/file")
  .header("apikey", "----Your API Key----")
  .field("your input image name", new File("/path/to/your/input/image.jpg|jpeg|png"))
  .asString();

var request = require('request');
var fs = require('fs');
var options = {
  'method': 'POST',
  'url': 'https://api.iapp.co.th/license-plate-recognition/file',
  'headers': {
    'apikey': '----Your API Key----'
  },
  formData: {
    'file': {
      'value': fs.createReadStream('/path/to/your/input/image.jpg|jpeg|png'),
      'options': {
        'filename': 'your input image name',
        'contentType': null
      }
    }
  }

#import <Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.iapp.co.th/license-plate-recognition/file"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"apikey": @"----Your API Key----"
};

[request setAllHTTPHeaderFields:headers];
NSArray *parameters = @[
  @{ @"name": @"your input image name", @"fileName": @"/path/to/your/input/image.jpg|jpeg|png" } 
];

2. (On-Premise only) Live Camera License Plate Recognition

On premise only.
LPR system post's detection to a specific URL internally.
External post requests to LPR system is not available in this version.

Post Detection Results

POST https://{URL}/new-detection/license-plate-number/

This endpoint allows you to save your detection according to the number of seconds you choose the results to be saved on the GUI or configuration file.

Request Body

{    "lp_number": "มข4320",    
     "vehicle_type": "car",    
     "vehicle_brand": "toyata",    
     "vehicle_color": "unknown",    
     "province": "กรุงเทพมหานคร",    
     "date_time": "2021 September 20 Monday at 16:34:34",    
     "source": "test/book.mp4 is a video file",    
     "name_source": "book"     
}

{    
    "message": "No vehicle detected."
    "message": "No license plate detected."
    "message": "Couldn't recognize the license plate"
}

This endpoint allows you to save your detection according to the number of seconds you choose the results to be saved on the GUI or configuration file.

{    "lp_number": "มข4320",    
     "vehicle_type": "car",    
     "vehicle_brand": "toyata",    
     "vehicle_color": "unknown",    
     "province": "กรุงเทพมหานคร",    
     "date_time": "2021 September 20 Monday at 16:34:34",    
     "source": "test/book.mp4 is a video file",    
     "name_source": "book"     
}

{    
    "message": "No vehicle detected."
    "status": 404
}


{    
    "message": "No license plate detected."
    "status": 404
}


{    
    "message": "Couldn't recognize the license plate"
    "status": 404
}

PreviousUsing PIP Python Package NextList of Supported Vehicle Brand

Last updated 1 year ago