Difference between revisions of "NPS-LIC"
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{#seo: |
| + | |title=API | ||
| + | |titlemode=append | ||
| + | |keywords=API, NPS-LIC, Motor Vehicle Licence Disk, Motor vehicle licence, barcode | ||
| + | |description=API interface to decode and test South African Motor Vehicle Licence Disk barcodes | ||
| + | }} | ||
| + | {{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 5: | Line 11: | ||
== 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 | + | See our [https://api.nptracker.co.za/docs/ API documentation page] for advanced help and examples on using this endpoint. |
=== Parameters === | === Parameters === | ||
==== scan ==== | ==== scan ==== | ||
| + | The URI encoded text string of the Licence disk PDF-417 barcode. | ||
| + | |||
==== vin ==== | ==== vin ==== | ||
| + | The 17 character VIN number to be tested. | ||
| + | |||
==== token ==== | ==== token ==== | ||
| + | This is your [[NPS-CLOUD]] account access token ([[API Key]]) available under the NPS-API menu in your NPS-CLOUD account. | ||
| + | |||
== Output == | == Output == | ||
| − | We provide a JSON formatted output of the results available from this API endpoint. | + | We provide a JSON formatted output of the results available from this API endpoint.<br> |
| − | [[File:NPS- | + | The barcode is encoded with data from the eNatis system linked to the vehicle.<br> |
| + | [[File:NPS-LIC JSON.png|400px|thumb|right|NPS-LIC JSON output]] | ||
=== VIN === | === VIN === | ||
| + | The decoded barcode (Vehicle Identification Number) VIN number for the vehicle. | ||
=== scan_plate === | === scan_plate === | ||
| + | The decoded barcode Vehicle number plate (Licence plate) for the vehicle. | ||
=== scan_manuf === | === scan_manuf === | ||
| + | The decoded barcode Vehicle manufacturer for the vehicle. | ||
=== scan_model === | === scan_model === | ||
| + | The decoded barcode Vehicle manufacturer for the vehicle. | ||
=== scan_class === | === scan_class === | ||
| + | The decoded barcode Vehicle class for the vehicle. | ||
=== scan_eng === | === scan_eng === | ||
| + | The decoded barcode Vehicle engine number for the vehicle. | ||
=== scan_date === | === scan_date === | ||
| + | The decoded barcode Vehicle licence disk expiry date for the vehicle. | ||
=== scan_type === | === scan_type === | ||
| + | We currently scan and decode the following barcode encoding formats: | ||
| + | * <strong>MVL</strong> - Motor Vehicle Licence | ||
| + | * <strong>RC</strong> - Registration Certificate. | ||
| + | |||
=== pic_url === | === pic_url === | ||
| + | The VIN number is used to provide an image of the same vehicle make and model for visual confirmation by an operator. | ||
=== manufacturer === | === manufacturer === | ||
| + | The manufacturer is linked to the propriety NPS-VCR system. | ||
=== plant === | === plant === | ||
| + | The manufacturer plant used to produce the vehicle linked in the propriety NPS-VCR system. | ||
=== brand === | === brand === | ||
| + | The manufacturer is linked to the propriety NPS-VCR system. | ||
=== model === | === model === | ||
| + | The vehicle model is linked to the propriety NPS-VCR system. | ||
=== year === | === year === | ||
| + | The vehicle manufacturer's release/production year is linked to the VIN number of the vehicle. | ||
=== engin_number === | === engin_number === | ||
| + | The vehicle's engine number is linked to the propriety NPS-VCR system. | ||
=== TokensLeft === | === TokensLeft === | ||
| + | The number of token credits left for your [[NPS-CLOUD]] account. | ||
=== unlock === | === unlock === | ||
| + | Returns a true report if the user is allowed to inquire about the license details.<br> | ||
| + | Return false if, for instance, the user's token credits have run out. | ||
=== checks === | === checks === | ||
==== np_tracker ==== | ==== np_tracker ==== | ||
| + | If <u>true</u> then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternatively it will return <u>false</u>. | ||
==== external ==== | ==== external ==== | ||
==== expired ==== | ==== expired ==== | ||
| + | If <u>true</u> then the date on the licence disk has expired, else <u>false</u> ie. disk is still valid. | ||
==== manufacturer ==== | ==== manufacturer ==== | ||
| + | If <u>true</u> then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>. | ||
==== model ==== | ==== model ==== | ||
| + | If <u>true</u> then the scanned vehicle model and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>. | ||
==== engine ==== | ==== engine ==== | ||
| + | If <u>true</u> then the scanned vehicle engine number and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>. | ||
==== colour ==== | ==== colour ==== | ||
| + | If <u>true</u> then the scanned vehicle colour and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a <u>false</u>. | ||
Latest revision as of 09:42, 31 May 2023
 This is the developer's corner to aid in integrating our RESTful API into their apps. |
Contents
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
scan
The URI encoded text string of the Licence disk PDF-417 barcode.
vin
The 17 character VIN number to be tested.
token
This is your NPS-CLOUD account access token (API Key) available under the NPS-API menu in your NPS-CLOUD account.
Output
We provide a JSON formatted output of the results available from this API endpoint.
The barcode is encoded with data from the eNatis system linked to the vehicle.
VIN
The decoded barcode (Vehicle Identification Number) VIN number for the vehicle.
scan_plate
The decoded barcode Vehicle number plate (Licence plate) for the vehicle.
scan_manuf
The decoded barcode Vehicle manufacturer for the vehicle.
scan_model
The decoded barcode Vehicle manufacturer for the vehicle.
scan_class
The decoded barcode Vehicle class for the vehicle.
scan_eng
The decoded barcode Vehicle engine number for the vehicle.
scan_date
The decoded barcode Vehicle licence disk expiry date for the vehicle.
scan_type
We currently scan and decode the following barcode encoding formats:
- MVL - Motor Vehicle Licence
- RC - Registration Certificate.
pic_url
The VIN number is used to provide an image of the same vehicle make and model for visual confirmation by an operator.
manufacturer
The manufacturer is linked to the propriety NPS-VCR system.
plant
The manufacturer plant used to produce the vehicle linked in the propriety NPS-VCR system.
brand
The manufacturer is linked to the propriety NPS-VCR system.
model
The vehicle model is linked to the propriety NPS-VCR system.
year
The vehicle manufacturer's release/production year is linked to the VIN number of the vehicle.
engin_number
The vehicle's engine number is linked to the propriety NPS-VCR system.
TokensLeft
The number of token credits left for your NPS-CLOUD account.
unlock
Returns a true report if the user is allowed to inquire about the license details.
Return false if, for instance, the user's token credits have run out.
checks
np_tracker
If true then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternatively it will return false.
external
expired
If true then the date on the licence disk has expired, else false ie. disk is still valid.
manufacturer
If true then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.
model
If true then the scanned vehicle model and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.
engine
If true then the scanned vehicle engine number and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.
colour
If true then the scanned vehicle colour and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.
