Documentation API V3
L’API V3 est disponible pour intégration à vos propres logiciels.
Vous pouvez maintenant utiliser votre interface habituelle pour effectuer des opérations comme la gestion des utilisateurs, la visualisation des événements d’accès, etc.
La documentation complète est disponible en lien sur chaque IBOX. Ci-dessous un exemple.

 

Exemple: Liste des événements

La liste des événements renvoyés par les contrôleurs XM200 vers l’IBOX est accessible via le chemin suivant:

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

Étant donné que cette liste peut-être volumineuse, il est possible de paginer la liste des résultats, pour ce faire il vous suffit de passer les deux paramètres suivants dans l’url:

  • page_size: le nombre de résultats par page (par défaut 100)
  • page: la page à afficher

Note: Les événements sont triés par date, du plus récent au plus ancien.

Exemple de requête (avec pagination de 5 éléments par page, affichage de la page 5):

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

Exemple de réponse (code 200):

{
    "count": 5,
    "results": [
        {
            "date": "2018-03-01 16:50:01",
            "code": 36,
            "name": "Désarmement par 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": "Armement par 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": "Désarmement par 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": "Armement par 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": "Accès autorisé",
            "controller_id": 2,
            "controller_name": "CTRL 01",
            "door_name": "Entrée piétons L1",
            "door_number": 1,
            "user_id": 8,
            "user_name": "07 07",
            "tag_code": 6349294,
            "alarm_name": null
        }
    ]
}