NPS-DL - Revision history

NPTracker at 07:39, 31 May 2023

2023-05-31T07:39:29Z

← Older revision		Revision as of 07:39, 31 May 2023
Line 6:		Line 6:
	}}		}}
	[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]		[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]
	{{API\|1=This is the developer's corner to aid in integrating our ~~RESTfull~~ API into their apps.}}		{{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 12:		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.

NPTracker at 07:33, 31 May 2023

2023-05-31T07:33:00Z

← Older revision		Revision as of 07:33, 31 May 2023
Line 26:		Line 26:
	[[File:NPS-DL JSON.png\|400px\|thumb\|right\|NPS-DL JSON output]]		[[File:NPS-DL JSON.png\|400px\|thumb\|right\|NPS-DL JSON output]]
	=== User_IP ===		=== User_IP ===
	~~Clients~~ IP address used to send the enquiry from.		Client's IP address that was used to send the enquiry from.

	=== EncryptionVersion ===		=== EncryptionVersion ===
			Returns the value set in the decrypted barcode.
	=== BarcodeVersion ===		=== BarcodeVersion ===
			Returns the value set in the decrypted barcode.
	=== Citizen ===		=== Citizen ===
			Returns the driver's citizen ISO code set in the decrypted barcode.
	=== Initial ===		=== Initial ===
			Driver's initial.
	=== Surname ===		=== Surname ===
			Driver's surname.
	=== DOB ===		=== DOB ===
			Driver's date of birth.
	=== IDNo ===		=== IDNo ===
			Driver's ID Number.
	=== IssuedBy ===		=== IssuedBy ===
			Issued state in ISO format.
	=== LicNo ===		=== LicNo ===
			Driver's licence number.
	=== Issued ===		=== Issued ===
			Date the card was first issued.
	=== ValidFrom ===		=== ValidFrom ===
			Date the card was issued/renewed.
	=== ValidTo ===		=== ValidTo ===
			Date the licence will expire.
	=== Code ===		=== Code ===
	~~Drivers~~ licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types...		The driver's licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types...
	==== Licence1 ====		==== Licence1 ====
	The first licence vehicle code the driver may operate.		The first licence vehicle code the driver may operate.
	==== Licence2 ====		==== Licence2 ====
	The second licence vehicle code the driver may operate.		The second licence vehicle code the driver may operate.

	=== Unlock ===		=== Unlock ===
	Returns a true ~~and~~ report if the user is allowed to inquire the drivers license details.<br>		Returns a true 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.		Return false if, for instance, the user's token credits have run out.

	=== Version ===		=== Version ===
	The version of the API endpoint.		The version of the API endpoint.

	=== TokensLeft ===		=== TokensLeft ===
			Current token credits left for the API account.
	=== Checks ===		=== Checks ===
			Addition checks based on data in the decrypted barcode.
	==== VehRestr ====		==== VehRestr ====
			Shows if the driver has a vehicle type restriction linked to his driver's licence (manual, automatic etc.)
	==== UserRestr ====		==== UserRestr ====
			Shows if the driver has a restriction type linked to his driver's licence (glasses, prosthetics etc.)
	==== PrDP ====		==== PrDP ====
	==== expired ====		==== expired ====
			The boolean value will be false if ValidTo date is past today's date else return true
	==== age ====		==== age ====
			The driver's age based on his ID number
	==== gender ====		==== gender ====
			The driver's gender is based on his ID number
	==== url ====		==== url ====
			Full URL for decoded driver's photo.<br>
			'''NOTE'': The photo decoding takes a second or two to be served by the server please allow a delay before retrieving the image.
	==== filename ====		==== filename ====
			The file path for decoded driver's photo.

NPTracker: /* Parameters */

2022-08-30T08:15:31Z

Parameters

← Older revision		Revision as of 08:15, 30 August 2022
Line 17:		Line 17:
	=== Parameters ===		=== Parameters ===
	==== scan ====		==== scan ====
	The HEX encoded string of the South African Drivers Licence (SADL) PDF-417 barcode.<br>This HEX string shall begin with 019b0945000025...		The HEX encoded string of the South African Drivers Licence (SADL) PDF-417 barcode.<br>This HEX string shall begin with 019b0945000025...<br>Please see our example application on [https://github.com/nptracker/NPS-SADL \| GitHub] for an example of how to convert from the PDF417 decoded binary format scan to the expected HEX value.

	==== token ====		==== token ====

NPTracker: /* scan */

2022-08-30T08:12:09Z

scan

← Older revision		Revision as of 08:12, 30 August 2022
Line 17:		Line 17:
	=== Parameters ===		=== Parameters ===
	==== scan ====		==== scan ====
	The HEX encoded ~~value~~ of the South African Drivers Licence (SADL) PDF-417 barcode.		The HEX encoded string of the South African Drivers Licence (SADL) PDF-417 barcode.<br>This HEX string shall begin with 019b0945000025...

	==== token ====		==== token ====

NPTracker: /* User_IP */

2019-04-12T06:56:06Z

User_IP

← Older revision		Revision as of 06:56, 12 April 2019
Line 26:		Line 26:
	[[File:NPS-DL JSON.png\|400px\|thumb\|right\|NPS-DL JSON output]]		[[File:NPS-DL JSON.png\|400px\|thumb\|right\|NPS-DL JSON output]]
	=== User_IP ===		=== User_IP ===
			Clients IP address used to send the enquiry from.

	=== EncryptionVersion ===		=== EncryptionVersion ===
	=== BarcodeVersion ===		=== BarcodeVersion ===

NPTracker: /* Unlock */

2019-04-12T06:54:17Z

Unlock

← Older revision		Revision as of 06:54, 12 April 2019
Line 46:		Line 46:

	=== 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.

	=== Version ===		=== Version ===
	The version of the API endpoint.		The version of the API endpoint.

NPTracker: /* Code */

2019-04-12T06:52:11Z

Code

← Older revision		Revision as of 06:52, 12 April 2019
Line 39:		Line 39:
	=== ValidTo ===		=== ValidTo ===
	=== Code ===		=== Code ===
			Drivers licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types...
	==== Licence1 ====		==== Licence1 ====
			The first licence vehicle code the driver may operate.
	==== Licence2 ====		==== Licence2 ====
			The second licence vehicle code the driver may operate.

	=== Unlock ===		=== Unlock ===
	=== Version ===		=== Version ===

NPTracker: /* Version */

2019-04-12T06:49:31Z

Version

← Older revision		Revision as of 06:49, 12 April 2019
Line 43:		Line 43:
	=== Unlock ===		=== Unlock ===
	=== Version ===		=== Version ===
			The version of the API endpoint.

	=== TokensLeft ===		=== TokensLeft ===
	=== Checks ===		=== Checks ===

NPTracker at 09:42, 11 April 2019

2019-04-11T09:42:26Z

← Older revision		Revision as of 09:42, 11 April 2019
Line 3:		Line 3:
	\|titlemode=append		\|titlemode=append
	\|keywords=NPS-DL, SADL, South African Drivers Licence		\|keywords=NPS-DL, SADL, South African Drivers Licence
	\|description=API interface to decode ~~south~~ African Drivers Licence barcodes ~~with~~		\|description=API interface to decode South African Drivers Licence barcodes
	}}		}}
	[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]		[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]

NPTracker at 09:40, 11 April 2019

2019-04-11T09:40:11Z

← Older revision		Revision as of 09:40, 11 April 2019
Line 6:		Line 6:
	}}		}}
	[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]		[[File:Datasheet240.png\|200px\|thumb\|right\|Datasheet240 NPS-DL. South African Drivers Licence barcode decoder API]]
	{{~~warning~~\|1=This is the developer's corner to aid in integrating our RESTfull API into their apps.}}		{{API\|1=This is the developer's corner to aid in integrating our RESTfull 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>