Difference between revisions of "NPS-LIC"

From NP Tracker projects
Jump to navigation Jump to search
(unlock)
Line 42: Line 42:
 
=== TokensLeft ===
 
=== TokensLeft ===
 
=== unlock ===
 
=== unlock ===
 +
Returns a true and report if the user is allowed to inquire the drivers license details.<br>
 +
Return false if, for instance, the users token credits have run out.
 +
 
=== checks ===
 
=== checks ===
 
==== np_tracker ====
 
==== np_tracker ====

Revision as of 08:55, 12 April 2019

Note This is the developer's corner to aid in integrating our RESTfull 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 advance 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.

NPS-LIC JSON output

VIN

scan_plate

scan_manuf

scan_model

scan_class

scan_eng

scan_date

scan_type

pic_url

manufacturer

plant

brand

model

year

engin_number

TokensLeft

unlock

Returns a true and report if the user is allowed to inquire the drivers license details.
Return false if, for instance, the users token credits have run out.

checks

np_tracker

external

expired

manufacturer

model

engine

colour