NPS-API: Difference between revisions
(→token) |
(→cmd) |
||
| Line 9: | Line 9: | ||
=== Parameters === | === Parameters === | ||
==== cmd ==== | ==== cmd ==== | ||
Command to execute ie. add,demo,ping,nps,mute,unmute | |||
===== add ===== | ===== add ===== | ||
Add a new lookout report for the supplied <i>str</i> vehicle registration numberplate. | |||
===== demo ===== | ===== demo ===== | ||
===== ping ===== | ===== ping ===== | ||
===== nps ===== | ===== nps ===== | ||
Test the supplied <i>str</i> vehicle registration numberplate. | |||
===== mute ===== | ===== mute ===== | ||
Mute the <i>str</i> vehicle registration numberplate and <strong>DON't</strong> provide a lookout report for this plate. | |||
===== unmute ===== | ===== unmute ===== | ||
Unmute the <i>str</i> vehicle registration numberplate and provide a lookout report for this plate again. | |||
==== str ==== | ==== str ==== | ||
==== token ==== | ==== token ==== | ||
Revision as of 18:25, 6 April 2019
 Warning: 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
cmd
Command to execute ie. add,demo,ping,nps,mute,unmute
add
Add a new lookout report for the supplied str vehicle registration numberplate.
demo
ping
nps
Test the supplied str vehicle registration numberplate.
mute
Mute the str vehicle registration numberplate and DON't provide a lookout report for this plate.
unmute
Unmute the str vehicle registration numberplate and provide a lookout report for this plate again.
str
token
This is your NPS-CLOUD account access token (API Key) available under the NPS-API menu in your NPS-CLOUD account.
id
trim
history
Output
We provide a JSON formatted output of the results available from this API endpoint.
