LUMO REST API voorbeelden

De NEDAP ANPR LUMO Kentekenlezer biedt automatische kentekenlezing. De camera kan worden geconfigureerd via de webgebaseerde interface. Voor integratiedoeleinden is er een REST API beschikbaar. Deze API kan voor verschillende doeleinden worden gebruikt, zoals integratie met de beschikbare toegangslijst.

Een leuke tool om REST API-opdrachten naast CURL te testen, is Postman https://www.postman.com/

In de bijlage vindt u ook enkele voorbeelden van POSTMAN link to attachment

Een volledige lijst met opdrachten is beschikbaar in de "ANPR LUMO Developer Guide"

Login

Dit API-eindpunt wordt gebruikt om in te loggen met eigen inloggegevens op de server. De login is vereist om elke andere actie op de server uit te voeren.

URL Methode URL Parameter Data parameter
 /login  post None login_string

Parameter


login_string

string met het volgende formaat : "username=your_username&password=your_password"

Voorbeelden:

# login
curl --cookie cookies.log --cookie-jar cookies.log http://192.168.3.15/login --data "username=admin&password=secret"

Digitale IO

Op de camera kunnen de digitale IO-pinnen worden gebruikt met het API-eindpunt voor het ophalen van de pinstatus en voor het activeren / deactiveren van beschikbare uitgangen. De GET-methode kan worden gebruikt om de status van alle pinnen op te halen en PATCH om de status van een uitvoerpin in te stellen.

URL Methode URL Parameter Data parameter
 /digitalio  GET  none  none
 /digitalio  PATCH  none  :value

 

Parameters

Waarde die de uitvoerpin specificeert en de status die op de gegeven pin moet worden ingesteld. Waarde is JSON struct met het volgende formaat:

parameter Value Format
 :value {
   "index": pin number <integer>,
   "set": true to activate or false to deactivate selected pin

 

Voorbeelden

# login
curl --cookie cookies.log --cookie-jar cookies.log http://192.168.3.15/login --data "username=admin&password=secret"
# get status of digital IO
curl --cookie cookies.log --cookie-jar cookies.log -X GET http://192.168.3.15/digitalio
# activate status of the output pin #1
curl --cookie cookies.log --cookie-jar cookies.log -X PATCH http://192.168.3.15/digitalio --data '{"index":1, "set":true}'

 

Ontvang TEXT Resultaten

Dit API-eindpunt retourneert een opgegeven aantal resultaten die het laatst zijn vastgelegd door de ANPR LUMO-camera.

Opmerking: u moet eerst de tekstresultaten in de Lumo-frontend opslaan. u kunt dit doen door de maximale historische lijstlengte en lijsturen te wijzigen.

URL Methode URL Parameter Data parameter
 /text/results  GET  none  json
 /text/results  DELETE  none  json

 

 Voorbeelden

# login
curl --cookie cookies.log --cookie-jar cookies.log http://192.168.3.15/login --data "username=admin&password=secret"
# retrieve 5 results
curl --cookie cookies.log --cookie-jar cookies.log -X GET http:// 192.168.3.15/text/results
--data '{"count":5}'
# retrieve 5 results with images
curl --cookie cookies.log --cookie-jar cookies.log -X GET http:// 192.168.3.15/text/results
--data '{"count":5,"include_images":true}'
# retrieve 10 results with a minimum confidence of 60 percent
curl --cookie cookies.log --cookie-jar cookies.log -X GET http:// 192.168.3.15/text/results
--data '{"count":10,"min-confidence":60}'

 

GET en SET Toegangslijst

API-eindpunten voor het ophalen en toevoegen van de toegangslijsten van de ANPR LUMO. Er zijn vier lijsten:
• white list lijstname = 'white.txt'
• black list lijstname = 'black.txt'
• ignore list lijstname = 'ignore.txt'
• wiegand matchlist lijstname = ‘wiegandlist.txt‘
Gebruik de GET-methode om de eigenschap op te halen en de PATCH-methode om deze in te stellen.

URL Methode URL Parameter Data parameter
 /access/:listname  GET  :listname  :filter (optional, can be empty)
 /access/:listname  PATCH  :listname  :entries
 /access/:listname  DELETE  :listname  :specifier

Ontvang een toegangslijst

Met een GET-verzoek wordt een lijst met kentekens teruggestuurd. De kentekenskunnen worden gefilterd door een JSON-document te verzenden met een patroonveld dat een reguliere expressie (RegEx) bevat.

Voeg een kenteken toe aan een toegangslijst

Met een POST-verzoek kan een nieuw item voor de toegangslijst worden toegevoegd. De hoofdtekst van het POST-verzoek moet een JSON-document bevatten in dezelfde indeling als een succesvol GET-verzoekantwoorddocument.

Verwijderen een kenteken van een toegangslijst 

Met een VERWIJDER-verzoek kunnen een of meer vermeldingen worden verwijderd door een van de twee velden in een JSON-document in de aanvraagtekst op te geven:
- index - verwijder een enkel item met het opgegeven indexnummer
- patroon - verwijder elk kenteken die overeenkomt met het gegeven patroon.

Examples 

# request whitelist
curl --cookie cookies.log --cookie-jar cookies.log http://192.168.3.15/access/white.txt
# add plate HHKF1114 to whitelist
curl --cookie cookies.log --cookie-jar cookies.log -X POST http://192.168.3.15/access/white.txt
--data '[{"always":true,"plate":"HHKF1114"}]'
# add HHKF1115 to whitelist which is valid from 01-10-2019 until 31-10-2019 on Monday, Tuesday and Wednesday from 08:00
unitl 18:30
curl --cookie cookies.log --cookie-jar cookies.log -X POST
http://192.168.3.15/access/white.txt --data '[{"always":false,"plate":"HHKF1115","schedules":[{"period":{"start":"2019-10-01",
"end":"2019-10-31"},"time-span":{"from":"08:00","to":"18:30"},"weekdays": ["Mo","Tu","We"]}]}]'
# request Wiegand matchlist
curl --cookie cookies.log --cookie-jar cookies.log http://192.168.3.15/access/wiegandlist.txt
# add HHKF1116 to Wiegand matchlist and match this to Wiegand ID 213
curl --cookie cookies.log --cookie-jar cookies.log -X POST http://192.168.3.15/access/wiegandlist.txt --data
'[{"always":true,"plate":"HHKF1116", "id": 213}]'
# delete plate with index number 1 from whitelist
curl --cookie cookies.log --cookie-jar cookies.log -X DELETE http://192.168.3.15/access/white.txt
--data '{"index":1}'
# delete plates with pattern HH from whitelist
curl --cookie cookies.log --cookie-jar cookies.log -X DELETE http://192.168.3.15/access/white.txt
--data '{"pattern":"HH*"}'

 

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 0 van 0
Hebt u meer vragen? Een aanvraag indienen