Difference between revisions of "NPS-SHARE"
(→message) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{#seo: | ||
| + | |title=API | ||
| + | |titlemode=append | ||
| + | |keywords=API, NPS-SHARE, Sharing intel, Crime-fighting, | ||
| + | |description=API interface to share and test incidents on clients' platform - supplied for free to the crime-fighting community | ||
| + | }} | ||
[[File:Datasheet220.png|200px|thumb|right|Datasheet220 NPS-SHARE. Sharing intel initiative]] | [[File:Datasheet220.png|200px|thumb|right|Datasheet220 NPS-SHARE. Sharing intel initiative]] | ||
| − | {{ | + | {{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> | ||
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 | + | See our [https://api.nptracker.co.za/docs/ API documentation page] for advanced help and examples on using this endpoint. |
=== Parameters === | === Parameters === | ||
==== message ==== | ==== message ==== | ||
| Line 13: | Line 19: | ||
==== token ==== | ==== token ==== | ||
| − | Contact us at [email protected] to create an access token and define your free details that users will see | + | Contact us at [email protected] to create an access token and define your free details so that users will see once a plate from your incident is looked up on NP Tracker. |
== Output == | == Output == | ||
| Line 19: | Line 25: | ||
[[File:NPS-SHARE JSON.png|400px|thumb|right|NPS-SHARE JSON output]] | [[File:NPS-SHARE JSON.png|400px|thumb|right|NPS-SHARE JSON output]] | ||
=== report === | === report === | ||
| + | Boolean value: | ||
| + | * <i>true</i>: There is an existing NP Tracker vehicle lookout report. See URL for a link to the lookout report. | ||
| + | * <i>false</i>: There is no lookout report for this vehicle currently in the NP Tracker system. | ||
=== plate === | === plate === | ||
| + | The first plate was detected in the submitted incident (message). | ||
=== url === | === url === | ||
| + | URL to the lookout report for the detected plate. | ||
Latest revision as of 09:43, 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 for third-party partners please contact us at [email protected] to set up an account.
See our API documentation page for advanced 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 so that users will see once a plate from your incident is 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 an 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 was detected in the submitted incident (message).
url
URL to the lookout report for the detected plate.
