Difference between revisions of "NPS-SHARE"
(→Usage) |
|||
Line 11: | Line 11: | ||
Available to any device/server on the internet. | Available to any device/server on the internet. | ||
== Usage == | == Usage == | ||
− | To use this endpoint you will need a valid | + | To use this endpoint you will need a valid API Key available for third-party partners please contact us at [email protected] to set up an account.<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 advance help and examples on using this endpoint. | ||
=== Parameters === | === Parameters === |
Revision as of 09:52, 13 February 2021
![]() |
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 for third-party partners please contact us at [email protected] to set up an account.
See our API documentation page for advance help and examples on using this endpoint.
Parameters
message
URI encoded a message of the incident you need to test and share with the NP Tracker project.
Please note that the incident will be logged in the NP Tracker suspect and suspicious database if it contains a vehicle registration number.
token
Contact us at [email protected] to create an access token and define your free details that users will see ones a plate from your incident are looked up on NP Tracker.
Output
We provide a JSON formatted output of the results available from this API endpoint.
report
boolean value:
- true: There is a existing NP Tracker vehicle lookout report. See url for a link to the lookout report.
- false: There is no lookout report for this vehicle currently in the NP Tracker system.
plate
The first plate that was detected in the submitted incident (message).
url
URL to the lookout report for the detected plate.