Ejemplos del API REST del ANPR Lumo

El lector de matrículas NEDAP ANPR LUMO ofrece lectura automática de matrículas. La cámara se puede configurar a través de la interfaz web. Para fines de integración, hay una API REST disponible. Esta API se puede usar para diferentes propósitos, como la integración con la lista de acceso disponible.

Una buena herramienta para probar los comandos REST API junto a CURL es postman https://www.postman.com/

En el archivo adjunto también puede encontrar algunos ejemplos de POSTMAN link to attachment

Una lista completa de comandos está disponible en la "ANPR LUMO Developer Guide"

Login

Este API Endpoint se utiliza para iniciar sesión con credenciales propias en el servidor. El inicio de sesión es necesario para realizar cualquier otra acción tomada en el servidor.

URL Method URL Parameter Data parameter
 /login  post None login_string

Parámetro

login_string
string con el siguiente formato : "username=your_username&password=your_password"

Ejemplo:

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

E/S Digital

En la cámara, los pines de E / S digitales se pueden usar con el Endpoint API para obtener el estado del pin y para activar / desactivar las salidas disponibles. El método GET se puede utilizar para obtener el estado de todos los pines y PATCH para establecer el estado de un pin de salida.

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

Parámetros

Valor que especifica el pin de salida y el estado que se establecerá en el pin dado. El valor es JSON struct con el siguiente formato:

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

Ejemplos

# 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}'

 

Recuperar resultado TEXTO

Este API Endpoint devuelve una cantidad específica de resultados que fueron capturados por última vez por la cámara ANPR LUMO.

nota: primero debe habilitar los resultados de texto para que se almacenen en el front-end del Lumo. puede hacerlo cambiando la longitud máxima de la lista histórica y las horas de la lista.

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

 

Ejemplos

# 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}'

 

OBTENER Y ESTABLECER Listas de acceso

API Endpoints para recuperar y agregar las listas de acceso de ANPR LUMO. Hay cuatro listas:
• lista blanca listname = 'white.txt'
• lista negra listname = 'black.txt'
• ignore list listname = 'ignore.txt'
• wiegand matchlist listname = ‘wiegandlist.txt‘
Use el método GET para recuperar la propiedad y el método PATCH para configurarla.

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

Recuperando una lista de acceso

Con una solicitud GET se devuelve una lista de placas. Las placas se pueden filtrar enviando un documento JSON que contiene un campo de patrón que contiene una expresión regular (RegEx).

Agregar una placa a una lista de acceso

Con una solicitud POST, se puede agregar una nueva entrada a la lista de acceso. El cuerpo de la solicitud POST debe contener un documento JSON en el mismo formato que el documento de respuesta de solicitud GET exitoso.

Eliminar una placa de una lista de acceso

Con una solicitud DELETE, se pueden eliminar una o más entradas especificando uno de los dos campos en un documento JSON dentro del cuerpo de la solicitud:
- índice: elimina un solo elemento con el número de índice dado
- patrón: elimina cada placa que coincida con el patrón dado.

Ejemplos 

# 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*"}'
¿Fue útil este artículo?
Usuarios a los que les pareció útil: 0 de 0
¿Tiene más preguntas? Enviar una solicitud