Go to documentation repository
The Axxon PSIM HTTP API allows you to access the Face PSIM. REST API or Auto PSIM. REST API via Web Server 2.0. To use this feature, you need the following:
- Face PSIM REST API:
- The Face Recognition Server object must be added to the Web server 2.0 filter (see Configuring the event filter for the Web server 2.0 module).
- The response to the request for the list of objects must contain an object FIRSERVER type (see Getting a list of all server objects).
- Auto PSIM REST API:
- The LPR channel object must be added to the Web server 2.0 filter (see Configuring the event filter for the Web server 2.0 module).
- The response to a request for a list of objects must contain an object of the ULPR type (see Getting a list of all server objects).
General request format
POST http://IP address:port/web2/secure/{vertical_solution}/{function}
Request parameters
Parameter | Is required | Description |
|---|---|---|
| vertical_solution | Yes | Specifies the vertical solution to access the API. Possible values: auto – Auto PSIM face – Face PSIM If face value is specified, then it is necessary to send the id of the Face Recognition Server to Face PSIM both in the URL and in the request body: POST http://IP-address:port/web2/secure/face/{server_id}/{function} |
| function | Yes | Vertical solution API function. See the description of the corresponding API |
Note.
Please refer to the documentation for the corresponding API function to see the parameters of the JSON sent in the POST request.
Request examples
POST http://1:1@127.0.0.1:8085/web2/secure/face/1/firserver/ReadPersons
{ "server_id": "1", "objectType": "PERSON", "id": [ ], "page": 1, "pageSize": 2 }
GET http://1:1@127.0.0.1:8085/web2/secure/auto/lprserver/GetImage/Frames/66FB34A2-1B38-E811-A92F-001A7DDA710E
Response examples
Please refer to the documentation for the corresponding vertical solution API for the response examples.
Overview
Content Tools