Technical Support | Suprema

Este artículo es una guía sencilla sobre cómo utilizar la API de CLUe para recuperar registros de eventos del servidor de CLUe.

A continuación se usan ejemplos de CURL y C# WPF .NET.

TABLA DE CONTENIDOS

• Prerrequisito
• Registrar usuario
• Recuperar registros

Prerrequisito

Para utilizar la API de CLUe, debe tener la siguiente información proporcionada.

• El PlaceID de tu tienda
• Clave de API
• Dispositivo conectado a CLUe para la autenticación

Registrar usuario

Para autenticar al usuario en el dispositivo, primero debe registrar al usuario en CLUe.

A continuación, los usuarios se sincronizan automáticamente con los dispositivos conectados en tiempo real.

1. Punto final y parámetros de la API

[PUBLICACIÓN] https://api.moon.supremainc.com/v1/be/places/:placeId/auths

Encabezado de la solicitud:

Variables de ruta:

2. Cuerpo de la solicitud

Solicite la siguiente información a su agente de Suprema.

Muestra:

curl --location 'https://api.moon.supremainc.com/v1/be/places/178/auths' \

--header 'Content-Type: application/json' \

--header 'Autorización: ••••••' \

--datos '{

    "usuario": {

        "key": "1234567",

        "name": "namehere"

    },

    "autenticación": {

        "startTime": 1718809200000,

        "endTime": 1718895540000,

        "doorAccessType": "ESPECÍFICO",

        "doorIds":[234, 235,236],

         "scheduleType":"ESPECÍFICO",

        "scheduleId":333,

        "credenciales": {

            "cartas": [

                {

                    "cardNumber": "12345",

                    "formatType": "CSN"

                }

            ],

             "faceImages":["/9j/4AAQSkZJRgABAQAASABIAA..."]

        },

         "activeStatus":"ACTIVO"

    }

}'

Genérico

3. Cuerpo de respuesta

{

    "código": 200,

    "status": verdadero,

    "message": "OK",

    "datos": {

        "authId": 118926,

        "lastModifiedAt": 1718841401642,

        "usuario": {

            "userId": 106569,

             "clave": "34DAB180-A14B-103B-8A4E-1166F21964DA",

            "name": "prueba",

            "realNameAuthStatusType": "REAL_NAME_AUTH_BEFORE"

        },

         "autenticación": {

             "startTime": 1718809200000,

             "endTime": 1718895540000,

             "doorAccessType": "ESPECÍFICO",

            "scheduleType": "ESPECÍFICO",

            "scheduleId": 333,

            "puertas": [

                {

                    "doorId": 234,

                    "doorName": "SmartLight"

                }

            ],

             "credenciales": {

                 "modos": [

                     "CARA"

                 ],

                 "faceImages": [

                     "Datos:Imagen/PNG; base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAA..."

                 ],

                 "name": "prueba"

            },

             "activeStatus": "ACTIVO"

        }

    }

}

HTML

Recuperar registros

1. Punto final y parámetros de la API

[OBTENER] https://api.moon.supremainc.com/v1/be/events?startTime=1719932400000&endTime=1720623540000&filterEvents=DEV_FACE_AUTH_SUCCESS%2CDEV_FACE_AUTH_FAIL&page=0&size=200&sort=id%2Casc&placeId={placeID}

Encabezado de la solicitud:

Parámetro de consulta:

curl --location 'https://api.moon.supremainc.com/v1/be/events?startTime=1719932400000&endTime=1720623540000&filterEvents=DEV_FACE_AUTH_SUCCESS%2CDEV_FACE_AUTH_FAIL&page=0&size=200&sort=id%2Casc&placeId=' \

--header 'Autorización: Portador api_key_here'

Genérico

2. Cuerpo de la solicitud

Ninguno

3. Cuerpo de respuesta

{

    "código": 200,

    "status": verdadero,

    "message": "OK",

    "total": 75,

    "datos": [

        {

            "logId": "XjIAM5ABcB2c2xupDI6m",

            "eventAt": 1718842554980,

            "placeId": 448,

            "deviceId": 1343,

            "doorId": 645,

            "localLogId": 25280,

            "eventType": "DEV_DOOR_RELAY_OFF"

        },

        {

            "logId": "XTIAM5ABcB2c2xupDI6m",

            "eventAt": 1718842553962,

            "placeId": 448,

            "deviceId": 1343,

            "doorId": 645,

            "localLogId": 25279,

            "eventType": "DEV_DOOR_RELAY_ON"

        },

        {

            "logId": "WzIAM5ABcB2c2xupDI6m",

            "eventAt": 1718842553904,

            "placeId": 448,

            "authId": 107909,

            "deviceId": 1343,

            "doorId": 645,

            "doorName": "SupremaJP_In",

            "userId": "c2119100-fbb0-1fdf-82c6-7dba89b5fe29",

            "userName": "jinlee",

            "localLogId": 25278,

            "eventType": "DEV_FACE_AUTH_SUCCESS"

        },

        {

            "logId": "iI7-MpABqzmfp6-HrEH7",

            "eventAt": 1718842462256,

            "placeId": 448,

            "deviceId": 1343,

            "doorId": 645,

            "localLogId": 25277,

            "eventType": "DEV_DOOR_RELAY_OFF"

        },

        {

            "logId": "h47-MpABqzmfp6-HrEH7",

            "eventAt": 1718842461243,

            "placeId": 448,

            "deviceId": 1343,

            "doorId": 645,

            "localLogId": 25276,

            "eventType": "DEV_DOOR_RELAY_ON"

        }

    ]

}

HTML

Explicación del evento

1. DEV_FACE_AUTH_SUCCESS - La plantilla de cara del usuario se registra en el servidor CLUe. Por lo tanto, es exitoso cuando el usuario se autentica desde el dispositivo
2. VENDOR_AUTH_SUCCESS - Significa que el ID del usuario (ejemplo 64455 arriba) está registrado y se le permite el acceso desde el sistema de terceros.
3. DEV_DOOR_RELAY_ON - El relé del dispositivo está encendido y la puerta está desbloqueada.
4. DEV_DOOR_RELAY_OFF - El relé del dispositivo está apagado y la puerta está bloqueada.

Ejemplo de flujo de eventos para el éxito de la autenticación

Ejemplo de flujo de eventos para la autenticación fallida (lado CLUe)

Ejemplo de flujo de eventos para la autenticación fallida (lado del sistema de terceros)