Assinaturas

Esta seção agrupa os comandos responsáveis pelo gerenciamento das assinaturas de servidor nos leitores de biometria facial. Esses recursos permitem configurar, atualizar e remover as definições de comunicação do dispositivo com servidores externos, garantindo o envio de eventos e dados em tempo real para sistemas de gerenciamento centralizados.

1. Criar Assinatura de Servidor (por Instância)

Descrição:

Cria uma nova assinatura de servidor no leitor de biometria facial, configurando o dispositivo para enviar eventos ou dados para um servidor específico, utilizando o ID de uma instância de conexão ativa.

POST /api/v1/facialRecognitions/instances/{id}/subscriptions

Quando Usar:

Para configurar o leitor para reportar eventos (como acessos ou falhas) a um sistema de gerenciamento central em tempo real.
Para estabelecer um canal de comunicação para a troca de dados entre o leitor e um servidor.

Criar uma assinatura de servidor no leitor de biometria facial por Instância conectada

post

Criar uma assinatura de servidor no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

ipAddressstring | nuloOpcional

portinteger · int32Opcional

eventTypestring · enumOpcionalValores possíveis:

durationinteger · int32Opcional

permanentbooleanOpcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/instances/{id}/subscriptions

POST /api/v1/facialRecognitions/instances/{id}/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "ipAddress": "text",
  "port": 1,
  "eventType": "AlarmSubscription",
  "duration": 1,
  "permanent": true
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "id": 1,
        "reference": "text",
        "currentTime": 1,
        "terminationTime": 1
      }
    }
  }
}

2. Criar Assinatura de Servidor (por ID)

Descrição:

Cria uma nova assinatura de servidor no leitor de biometria facial, configurando o dispositivo para enviar eventos ou dados para um servidor específico, utilizando o ID do dispositivo registrado no sistema.

POST /api/v1/facialRecognitions/{id}/subscriptions

Quando Usar:

Para provisionar assinaturas de servidor em leitores remotos a partir de um sistema de gerenciamento central.
Para automatizar a configuração de comunicação de múltiplos dispositivos com um servidor.

Criar uma assinatura de servidor no leitor de biometria facial

post

Criar uma assinatura de servidor no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

ipAddressstring | nuloOpcional

portinteger · int32Opcional

eventTypestring · enumOpcionalValores possíveis:

durationinteger · int32Opcional

permanentbooleanOpcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/{id}/subscriptions

POST /api/v1/facialRecognitions/{id}/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "ipAddress": "text",
  "port": 1,
  "eventType": "AlarmSubscription",
  "duration": 1,
  "permanent": true
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "id": 1,
        "reference": "text",
        "currentTime": 1,
        "terminationTime": 1
      }
    }
  }
}

3. Atualizar Assinatura de Servidor (por Instância)

Descrição:

Atualiza uma assinatura de servidor existente no leitor de biometria facial, modificando os parâmetros de comunicação ou o servidor de destino, utilizando o ID de uma instância de conexão ativa.

PUT /api/v1/facialRecognitions/instances/{id}/subscriptions

Quando Usar:

Para alterar o endereço IP do servidor de destino ou ajustar as configurações de notificação em tempo real.
Para modificar uma assinatura existente sem precisar recriá-la.

Atualizar uma assinatura de servidor no leitor de biometria facial por Instância conectada

put

Atualizar uma assinatura de servidor no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da instância conectada

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

subscriptionIdinteger · int32Opcional

durationinteger · int32Opcional

permanentbooleanOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

put

/api/v1/facialRecognitions/instances/{id}/subscriptions

PUT /api/v1/facialRecognitions/instances/{id}/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "subscriptionId": 1,
  "duration": 1,
  "permanent": true
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "id": 1,
        "reference": "text",
        "currentTime": 1,
        "terminationTime": 1
      }
    }
  }
}

4.Atualizar Assinatura de Servidor (por ID)

Descrição:

Atualiza uma assinatura de servidor existente no leitor de biometria facial, modificando os parâmetros de comunicação ou o servidor de destino, utilizando o ID do dispositivo registrado no sistema.

PUT /api/v1/facialRecognitions/{id}/subscriptions

Quando Usar:

Para atualizar assinaturas de servidor em leitores remotos a partir de um sistema de gerenciamento central.
Para aplicar alterações em políticas de comunicação em múltiplos dispositivos de forma automatizada.

Atualizar uma assinatura de servidor no leitor de biometria facial

put

Atualizar uma assinatura de servidor no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

subscriptionIdinteger · int32Opcional

durationinteger · int32Opcional

permanentbooleanOpcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

put

/api/v1/facialRecognitions/{id}/subscriptions

PUT /api/v1/facialRecognitions/{id}/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "subscriptionId": 1,
  "duration": 1,
  "permanent": true
}

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": {
        "id": 1,
        "reference": "text",
        "currentTime": 1,
        "terminationTime": 1
      }
    }
  }
}

5. Apagar Assinatura de Servidor (por Instância)

Descrição:

Apaga uma assinatura de servidor específica do leitor de biometria facial, interrompendo o envio de eventos ou dados para o servidor configurado, utilizando o ID de uma instância de conexão ativa.

DELETE /api/v1/facialRecognitions/instances/{id}/subscriptions/{idSubscription}

Quando Usar:

Para desativar a comunicação de um leitor com um servidor específico em tempo real.
Para remover assinaturas de servidor que não são mais necessárias ou que foram substituídas.

Apagar assinatura de servidor no leitor de biometria facial por Instância conectada

delete

Apagar assinatura de servidor no leitor de biometria facial por Instância conectada

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int32Obrigatório

Id da Instância conectada

idSubscriptioninteger · int32Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a deleção ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

delete

/api/v1/facialRecognitions/instances/{id}/subscriptions/{idSubscription}

DELETE /api/v1/facialRecognitions/instances/{id}/subscriptions/{idSubscription} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text"
    }
  }
}

6.Apagar Assinatura de Servidor (por ID)

Descrição:

Apaga uma assinatura de servidor específica do leitor de biometria facial, interrompendo o envio de eventos ou dados para o servidor configurado, utilizando o ID do dispositivo registrado no sistema.

DELETE /api/v1/facialRecognitions/{id}/subscriptions/{idSubscription}

Quando Usar:

Para remover assinaturas de servidor de leitores remotos a partir de um sistema de gerenciamento central.
Para automatizar a remoção de configurações de comunicação obsoletas em múltiplos dispositivos.

Apagar assinatura de servidor no leitor de biometria facial

delete

Apagar assinatura de servidor no leitor de biometria facial

Autorizações

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Id do leitor de biometria facial

idSubscriptioninteger · int32Obrigatório

Id assinatura

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

Quando a deleção ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

delete

/api/v1/facialRecognitions/{id}/subscriptions/{idSubscription}

DELETE /api/v1/facialRecognitions/{id}/subscriptions/{idSubscription} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text"
    }
  }
}

AnteriorUsuários PróximoAcionamento Remoto de Relé

Atualizado há 3 meses

hashtag 1. Criar Assinatura de Servidor (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar uma assinatura de servidor no leitor de biometria facial por Instância conectada

hashtag2. Criar Assinatura de Servidor (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar uma assinatura de servidor no leitor de biometria facial

hashtag3. Atualizar Assinatura de Servidor (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar uma assinatura de servidor no leitor de biometria facial por Instância conectada

hashtag 4.Atualizar Assinatura de Servidor (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar uma assinatura de servidor no leitor de biometria facial

hashtag5. Apagar Assinatura de Servidor (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagApagar assinatura de servidor no leitor de biometria facial por Instância conectada

hashtag6.Apagar Assinatura de Servidor (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagApagar assinatura de servidor no leitor de biometria facial

1. Criar Assinatura de Servidor (por Instância)

Descrição:

Quando Usar:

Criar uma assinatura de servidor no leitor de biometria facial por Instância conectada

2. Criar Assinatura de Servidor (por ID)

Descrição:

Quando Usar:

Criar uma assinatura de servidor no leitor de biometria facial

3. Atualizar Assinatura de Servidor (por Instância)

Descrição:

Quando Usar:

Atualizar uma assinatura de servidor no leitor de biometria facial por Instância conectada

4.Atualizar Assinatura de Servidor (por ID)

Descrição:

Quando Usar:

Atualizar uma assinatura de servidor no leitor de biometria facial

5. Apagar Assinatura de Servidor (por Instância)

Descrição:

Quando Usar:

Apagar assinatura de servidor no leitor de biometria facial por Instância conectada

6.Apagar Assinatura de Servidor (por ID)

Descrição:

Quando Usar:

Apagar assinatura de servidor no leitor de biometria facial