API V3 Documentation
The V3 API is now available. You can integrate it to your own softwares.
You can now use your usual interface to do some actions, like managing users, seeing access events, etc.
The entire documentation is available by clicking on the link in each IBOX’s description. Here is an example.

 

Example : Events list

The events that have been returned to the IBOX by the XM200 controlers can be seen by following the path :

  • Method: GET
  • Path: /api/controllers/

Because that this list can be quite big, it’s possible to paginate it. To do so, you just need to enter these to parameters in the url :

  • page_size: the number of results per page ( 100 by default)
  • page: the page to display

Note: The events are ordered by date, from the more recent to the oldest.

Example of request (with 5 elements per page, and display of the 5th page):

$ curl -k -u api:s3crEtp4ss "https://iboxv3.local/api/events/?page_size=5&page=5"

Example of response (code 200):

{
    "count": 5,
    "results": [
        {
            "date": "2018-03-01 16:50:01",
            "code": 36,
            "name": "Disarmed by PC",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": null,
            "door_number": null,
            "user_id": null,
            "user_name": null,
            "tag_code": null,
            "alarm_name": null
        },
        {
            "date": "2018-03-01 16:49:57",
            "code": 35,
            "name": "Armed by PC",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": null,
            "door_number": null,
            "user_id": null,
            "user_name": null,
            "tag_code": null,
            "alarm_name": null
        },
        {
            "date": "2018-03-01 16:49:54",
            "code": 36,
            "name": "Disarmed by PC",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": null,
            "door_number": null,
            "user_id": null,
            "user_name": null,
            "tag_code": null,
            "alarm_name": null
        },
        {
            "date": "2018-03-01 16:49:48",
            "code": 35,
            "name": "Armed by PC",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": null,
            "door_number": null,
            "user_id": null,
            "user_name": null,
            "tag_code": null,
            "alarm_name": null
        },
        {
            "date": "2018-03-01 16:23:30",
            "code": 48,
            "name": "Acces granted",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": "Pedestrian entry L1",
            "door_number": 1,
            "user_id": 8,
            "user_name": "07 07",
            "tag_code": 6349294,
            "alarm_name": null
        }
    ]
}