Receptores

A entidade Receiver representa os receptores integrados ao sistema de controle de acesso, responsáveis por captar dados operacionais dos dispositivos. Estes receptores podem ser sincronizados com controladoras específicas ou por instância, e possuem endpoints para consultar sua versão e status de integração.

1. Sincronização por Instância Conectada

Descrição:

Realiza a sincronização de todos os receptores com as controladoras de acesso conectadas à instância atual.

• POST /api/v1/receivers/syncs

Quando Usar:

• Após alterações em configurações de dispositivos ou permissões.

• Para garantir que todos os receptores da instância estejam atualizados com as últimas configurações.

Sincronização dos Receptores com o controlador de acesso conectado por instância

post

Sincronização dos Receptores com o controlador de acesso conectado por instância

Autorizações

BearerApiKey

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 consulta

instanceinteger · int32Obrigatório

Id da instância da conexão

cultureNamestringOpcional

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

Default: en-US

Respostas

200

Quando a sincronização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/receivers/syncs

HTTPcURLJavaScriptPython

POST /api/v1/receivers/syncs?instance=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "result": "text",
    "duration": "text"
  }
}

2. Sincronização do receptor por controlador de acesso

Descrição:

Sincroniza os receptores vinculados a uma controladora de acesso específica, identificada por {id}.

• POST /api/v1/receivers/syncs/accessControllers/{id}

Quando Usar:

• Quando há necessidade de atualizar apenas uma controladora individualmente.

• Para operações pontuais de sincronização sem afetar os demais dispositivos da instância.

Sincronização dos Receptores com o controlador de acesso

post

Sincronização dos Receptores com o controlador de acesso

Autorizações

BearerApiKey

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 controlador de acesso na base de dados para vinculação do dispositivo

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 sincronização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/receivers/syncs/accessControllers/{id}

HTTPcURLJavaScriptPython

POST /api/v1/receivers/syncs/accessControllers/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "result": "text",
    "duration": "text"
  }
}

3. Obter versão do receptor por Instância

Descrição:

Retorna a versão dos receptores conectados à instância atual.

• GET /api/v1/receivers/versions

Quando Usar:

• Para verificar se os receptores estão atualizados com a versão mais recente.

• Para validação durante etapas de atualização de firmware ou compatibilidade com controladoras.

Obter versão dos Receptores por instância conectada

get

Obter versão dos Receptores por instância conectada

Autorizações

BearerApiKey

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 consulta

instanceinteger · int32Obrigatório

Id da instância da conexão

typeTriggerDevicestring · enumObrigatório

Tipo do aparelho acionador

Valores possíveis:

numberTriggerDeviceinteger · int32Obrigatório

Posição

cultureNamestringOpcional

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

Default: en-US

Respostas

200

Quando a obtenção da versão ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/receivers/versions

HTTPcURLJavaScriptPython

GET /api/v1/receivers/versions?instance=1&typeTriggerDevice=RF&numberTriggerDevice=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "typeTriggerDevice": "text",
    "typeTriggerDeviceId": 1,
    "positionNumber": 1,
    "version": {
      "majorVersion": "text",
      "minorVersion": "text",
      "release": "text",
      "build1": "text",
      "build2": "text",
      "fullVersion": "text"
    }
  }
}

4. Obter versão do receptor por id

Descrição:

Obtém a versão dos Receptores.

• GET /api/v1/receivers/versions/accessControllers/{id}

Quando Usar:

• Para inspeção pontual da versão dos receptores de uma única controladora.

• Em procedimentos de diagnóstico ou atualização individual de dispositivos.

Obter versão dos Receptores

get

Obter versão dos Receptores

Autorizações

BearerApiKey

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

Parâmetros de consulta

typeTriggerDevicestring · enumObrigatório

Tipo do aparelho acionador

Valores possíveis:

numberTriggerDeviceinteger · int32Obrigatório

Posição

cultureNamestringOpcional

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

Default: en-US

Respostas

200

Quando a obtenção da versão ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/receivers/versions/accessControllers/{id}

HTTPcURLJavaScriptPython

GET /api/v1/receivers/versions/accessControllers/{id}?typeTriggerDevice=RF&numberTriggerDevice=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "typeTriggerDevice": "text",
    "typeTriggerDeviceId": 1,
    "positionNumber": 1,
    "version": {
      "majorVersion": "text",
      "minorVersion": "text",
      "release": "text",
      "build1": "text",
      "build2": "text",
      "fullVersion": "text"
    }
  }
}

5. Obter as entradas digitais por id

Descrição:

Obtém as entradas digitais do receptor por ID da controladora de acesso.

• GET /api/v1/receivers/digitalInputs/accessControllers/{id}

Quando Usar:

• Para inspeção pontual das entradas digitais de uma única controladora.

• Em procedimentos de diagnóstico ou verificação de status dos dispositivos conectados.

Obter entradas digitas

get

Obter entradas digitas

Autorizações

BearerApiKey

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 controlador de acesso

Parâmetros de consulta

typeTriggerDevicestring · enumObrigatório

RF (Controle remoto), TA (Tag Ativa), CT (Cartão), BM (Biometria), TP (Tag Passiva), SN (Senha)

Valores possíveis:

deviceNumberinteger · int32Obrigatório

Número do dispositivo de 0 a 7

cultureNamestringOpcional

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

Default: en-US

Respostas

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/receivers/digitalInputs/accessControllers/{id}

HTTPcURLJavaScriptPython

GET /api/v1/receivers/digitalInputs/accessControllers/{id}?typeTriggerDevice=RF&deviceNumber=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "typeTriggerDevice": "text",
    "typeTriggerDeviceId": 1,
    "deviceNumber": 1,
    "input": {
      "ed1L1": true,
      "ed2L1": true,
      "ed3L1": true,
      "ed4L1": true,
      "ed1L2": true,
      "ed2L2": true,
      "ed3L2": true,
      "ed4L2": true,
      "ed1L3": true,
      "ed2L3": true,
      "ed3L3": true,
      "ed4L3": true,
      "ed1L4": true,
      "ed2L4": true,
      "ed3L4": true,
      "ed4L4": true
    }
  }
}

6. Obter as entradas digitais por instância

Descrição:

Obtém as entradas digitais do receptor por instância conectada.

• GET /api/v1/receivers/digitalInputs

Quando Usar:

• Para verificar em tempo real o estado das entradas digitais de um receptor específico conectado.

• Em procedimentos de diagnóstico ou monitoramento contínuo das entradas.

Obter entradas digitas por Instância conectada

get

Obter entradas digitas por Instância conectada

Autorizações

BearerApiKey

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 consulta

instanceinteger · int32Obrigatório

Id da instância da conexão

typeTriggerDevicestring · enumObrigatório

RF (Controle remoto), TA (Tag Ativa), CT (Cartão), BM (Biometria), TP (Tag Passiva), SN (Senha)

Valores possíveis:

deviceNumberinteger · int32Obrigatório

Número do dispositivo de 0 a 7

cultureNamestringOpcional

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

Default: en-US

Respostas

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/receivers/digitalInputs

HTTPcURLJavaScriptPython

GET /api/v1/receivers/digitalInputs?instance=1&typeTriggerDevice=RF&deviceNumber=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "typeTriggerDevice": "text",
    "typeTriggerDeviceId": 1,
    "deviceNumber": 1,
    "input": {
      "ed1L1": true,
      "ed2L1": true,
      "ed3L1": true,
      "ed4L1": true,
      "ed1L2": true,
      "ed2L2": true,
      "ed3L2": true,
      "ed4L2": true,
      "ed1L3": true,
      "ed2L3": true,
      "ed3L3": true,
      "ed4L3": true,
      "ed1L4": true,
      "ed2L4": true,
      "ed3L4": true,
      "ed4L4": true
    }
  }
}