Aller au contenu principal

Format des payloads

Ce document décrit les spécifications de nos payloads. Il comprend une section générale applicable à tous les devices et des sections spécifiques pour chaque application.

Global​

Keepalive​

Les messages Keepalive sont envoyés toutes les 10 minutes pour vérifier l'intégrité de la connexion.

GET https://{webhook_url}?source=VIZIOSENSE&id={device_id} HTTP/1.1
User-Agent: axios/1.3.5
Content-Type: application/json
Accept: application/json, text/plain, */*

Paramètres de la chaîne de requête envoyés:

  • source: Source du message (toujours à VIZIOSENSE).
  • id: L'ID de votre capteur.

Applications​

Chaque payload d'application suit un schéma commun:

POST https://{webhook_url} HTTP/1.1
User-Agent: axios/1.3.5
Content-Type: application/json
Accept: application/json, text/plain, */*

{
  "stream_id": "<your_device_id>",
  "type": "<application_type>",
  "timestamp": "<event_timestamp>",
  "payload": "<application_specific_payload>"
}

Attributs du message:

  • stream_id: L'ID de votre capteur.
  • timestamp: L'horodatage au format UNIX (UTC) du message.
  • type: Le code du type d'application, qui définit le format du payload pour chaque application :
  • payload: La charge utile spécifique à l'application (comme spécifié ci-dessous).

Viziopark​

Les payloads de Viziopark sont envoyées chaque fois qu'une place de parking surveillée change d'état. Le débit est limité à 1 payload toutes les 30 secondes afin d'éviter le spam :

[
    {
      "name": "P-0",
      "is_active": true,
      "deactivated": false,
      "cls": "car",
      "id": "c2b69525-974e-4d26-a80c-70817a628e08",
      "event_ts": 1705682525
    },
    {
      "name": "P-1",
      "is_active": true,
      "deactivated": false,
      "cls": "truck",
      "id": "20acf01e-9ed0-4211-8ccd-67c931bb41a5",
      "event_ts": 1705682280
    },
    {
      "name": "P-2",
      "is_active": false,
      "deactivated": false,
      "cls": null,
      "id": "be4efad5-cf22-40a2-bf75-7dcf16ef801f",
      "event_ts": 1705682577
    }
]

Attributs de la charge utile:

  • id: L'ID de la place de parking.
  • event_ts: L'horodatage au format UNIX (UTC) de l'événement.
  • name: Le nom de la place de parking tel qu'il est défini dans la plateforme intégrateur.
  • is_active: L'état actuel de la place surveillée (true si occupée).
  • deactivated: L'état actuel de désactivation de la place surveillée (true si désactivée).
  • cls: La classe du vehicule garé (exemple: car, bus, truck) ou null si la place surveillée est libre ou désactivée. C'est un attribut optionnel.
  • plate: Le texte associé à la plaque d'immatriculation du véhicule garé (exemple: ER-891-WJ) ou null si la place surveillée est libre ou désactivée. C'est un attribut optionnel.

Vizioyard​

Les payloads de Vizioyard sont envoyées chaque fois qu'un emplacement surveillée change d'état. Le débit est limité à 1 payload toutes les 30 secondes afin d'éviter le spam :

[
    {
      "name": "Y-0",
      "is_active": true,
      "deactivated": false,
      "cls": "truck",
      "plate": "EC-562-WJ",
      "id": "5e1f581d-cf32-42ac-81d4-b9ec3af91159",
      "event_ts": 1770909921
    },
    {
      "name": "Y-1",
      "is_active": true,
      "deactivated": false,
      "cls": "truck",
      "plate": "BZ-348-BY",
      "id": "a17b7fdf-0dd8-4621-b89d-c3183f19c371",
      "event_ts": 1770908400
    },
    {
      "name": "Y-2",
      "is_active": false,
      "deactivated": false,
      "cls": null,
      "plate": null,
      "id": "71d35b0e-5c46-4816-a2ef-417a73280cf3",
      "event_ts": 1770907200
    }
]

Attributs de la charge utile:

  • id: L'ID de l'emplacement.
  • event_ts: L'horodatage au format UNIX (UTC) de l'événement.
  • name: Le nom de l'emplacement tel qu'il est défini dans la plateforme intégrateur.
  • is_active: L'état actuel de l'emplacement surveillé (true si occupée).
  • deactivated: L'état actuel de désactivation de l'emplacement surveillé (true si désactivée).
  • cls: La classe du vehicule garé (exemple: truck, trucktrailer, truckhead) ou null si l'emplacement surveillé est libre ou désactivé. C'est un attribut optionnel.
  • plate: Le texte associé à la plaque d'immatriculation du véhicule garé (exemple: ER-891-WJ) ou null si l'emplacement surveillé est libre ou désactivé. C'est un attribut optionnel.
  • ocr: Identifiant unique associé au véhicule (exemple: identifiant d'un conteneur ou d'une remorque), ou null si l'emplacement surveillé est libre ou désactivé. C'est un attribut optionnel.

Viziocount​

Comptage par zone​

Compte les objets dans une zone sur une période donnée (par défaut : 30 secondes). Les données utiles sont envoyées à la fin de chaque période de comptage, seulement si le compte est supérieur à 1.

[
    {
        "name": "Polygon_1",
        "id": "ba3b60ab-659f-469f-bf5e-4b19124a055d",
        "event_ts": 1705938983,
        "objects": [
            {
                "count": 10,
                "cls": "person"
            }
        ]
    }
]

Attributs du payload:

  • id: L'ID de la zone de comptage.
  • event_ts: L'horodatage au format UNIX (UTC) de l'événement.
  • name: Le nom de la zone de comptage tel que défini dans la plateforme intégrateur.
  • objets: Un tableau d'objets détectés.
    • cls: La classe de l'objet détecté (par exemple, person, car, bus, truck, motorcycle).
    • count: Le nombre d'objets comptés pendant la période définie.

comptage par franchissement de barrière​

Compte les objets qui franchissent une barrière sur une période donnée (par défaut : 30 secondes). Les données utiles sont envoyées à la fin de chaque période de comptage, seulement si le compte est supérieur à 1.

[
    {
        "name": "Entry",
        "start_ts": 1705938983,
        "id": "ba3b60ab-659f-469f-bf5e-4b19124a055d",
        "end_ts": 1705939013,
        "objects": [
            {
            "count": 1,
            "cls": "vehicle"
            }
        ]
    },
    {
        "name": "Exit",
        "start_ts": 1705938983,
        "id": "aead1317-44e8-4143-8d74-7740c30c5752",
        "end_ts": 1705939013,
        "objects": [
            {
            "count": 1,
            "cls": "vehicle"
            }
        ]
    }
]

Attributs de la charge utile:

  • id: L'ID de la barrière.
  • start_ts: L'horodatage de début de période au format UNIX (UTC).
  • end_ts: L'horodatage de fin de période au format UNIX (UTC).
  • name: Le nom de la barrière tel qu'il est défini dans la plateforme intégrateur.
  • objects: Un tableau d'objets détectés.
    • cls: La classe de l'objet détecté (par exemple, person, vehicle).
    • count: Le nombre d'objets comptés pendant la période définie.

Viziocrowd​

Viziocrowd fournit des mesures de foule pour différentes zones de comptage. Il comprend le nombre minimum, maximum et moyen de personnes présentes dans chaque zone sur une période donnée (par défaut : 10 minutes).

[
    {
        "name": "Polygon_1",
        "start_ts": 1705685956,
        "id": "9a6f509b-14dc-4338-8fda-dd14e0baadaf",
        "end_ts": 1705686557,
        "objects": [
        {
            "cls": "person",
            "min": 0,
            "avg": 6,
            "max": 49
        }
        ]
    },
    {
        "name": "Polygon_2",
        "start_ts": 1705685956,
        "id": "438ba09c-8f49-409d-9e5a-50070ce66f30",
        "end_ts": 1705686557,
        "objects": [
        {
            "cls": "person",
            "min": 0,
            "avg": 0,
            "max": 7
        }
        ]
    }
]

Attributs de la charge utile:

  • id: L'ID de la zone de détection.
  • start_ts: L'horodatage de début de période au format UNIX (UTC).
  • end_ts: L'horodatage de fin de période au format UNIX (UTC).
  • name: Le nom de la zone de détection tel qu'il est défini dans la plateforme intégrateur.
  • objects: Un tableau d'objets détectés.
    • cls: La classe de l'objet détecté (person).
    • min: Le nombre minimum d'objets détectés au cours de la période d'agrégation.
    • avg: Le nombre moyen d'objets détectés au cours de la période d'agrégation.
    • max: Le nombre maximum d'objets détectés au cours de la période d'agrégation.

Payload Details​

Loading ....