Difference between revisions of "NPS-ANPR"

From NP Tracker projects
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
For info on our public domain ANPS camera project see our [http://www.nptracker.co.za/ANPR.html NPS-ANPR info page].<br>
+
{{#seo:
{{warning|1=This is the developer's corner to aid in integrating our RESTfull API into their apps.}}
+
|title=API
 +
|titlemode=append
 +
|keywords=NPS-ANPR, NP Tracker, ANPR, Automatic Number Plate Recognition, LRP, Licence Plate Recognition
 +
|description=Our API and Raspberry pi ANPR projects.
 +
}}
 +
For info on our public domain, ANPS (Automatic Number Plate Recognition) or LPR (Licence Plate Recognition) camera project build on the Raspberry Pi platform see our [http://www.nptracker.co.za/ANPR.html NPS-ANPR info page].<br>
 +
{{API|1=This is the developer's corner to aid in integrating our RESTful API into their apps.}}
 
== Interface ==
 
== Interface ==
 
This is a [[REST API]] endpoint using HTTP GET.<br>
 
This is a [[REST API]] endpoint using HTTP GET.<br>
Line 6: Line 12:
 
== Usage ==
 
== Usage ==
 
To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br>
 
To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br>
See our [https://api.nptracker.co.za/docs API documentation page] for advance help and examples on using this endpoint.
+
See our [https://api.nptracker.co.za/docs/ API documentation page] for advanced help and examples on using this endpoint.
 
=== Parameters ===
 
=== Parameters ===
 
==== plates ====
 
==== plates ====
 
==== token ====
 
==== token ====
 +
This is your [[NPS-CLOUD]] account access token ([[API Key]]) available under the NPS-API menu in your NPS-CLOUD account.
 +
 
==== event ====
 
==== event ====
 
==== confidence ====
 
==== confidence ====
Line 16: Line 24:
 
[[File:NPS-ANPR JSON.png|400px|thumb|right|NPS-ANPR JSON output]]
 
[[File:NPS-ANPR JSON.png|400px|thumb|right|NPS-ANPR JSON output]]
 
=== validplate ===
 
=== validplate ===
 +
Will test supplied <u>plates</u> string for plates and return a true when a plate match in the plate detector algorithm, else return false.
 +
 
=== responce_ms ===
 
=== responce_ms ===
 +
Show the script's response time in milliseconds from the initial request to the display of results.

Latest revision as of 09:37, 31 May 2023

For info on our public domain, ANPS (Automatic Number Plate Recognition) or LPR (Licence Plate Recognition) camera project build on the Raspberry Pi platform see our NPS-ANPR info page.

Note This is the developer's corner to aid in integrating our RESTful API into their apps.


Interface

This is a REST API endpoint using HTTP GET.
Available to any device/server on the internet.

Usage

To use this endpoint you will need a valid API Key available after registration on NPS-CLOUD.
See our API documentation page for advanced help and examples on using this endpoint.

Parameters

plates

token

This is your NPS-CLOUD account access token (API Key) available under the NPS-API menu in your NPS-CLOUD account.

event

confidence

Output

We provide a JSON formatted output of the results available from this API endpoint.

NPS-ANPR JSON output

validplate

Will test supplied plates string for plates and return a true when a plate match in the plate detector algorithm, else return false.

responce_ms

Show the script's response time in milliseconds from the initial request to the display of results.