Assinaturas

Esta seção gerencia as assinaturas para o recebimento de eventos de diversos tipos de dispositivos acionadores (TP, SN, RF, CT, BM). Os endpoints permitem criar, consultar, atualizar e remover subscrições, garantindo que o sistema possa receber e processar notificações específicas de cada tipo de equipamento.

1. Obter Subscrições por Filtro

Descrição:

Retorna uma lista de subscrições de eventos cadastradas no sistema, com a possibilidade de aplicar filtros para refinar a busca, como por tipo de dispositivo acionador.

GET /api/v1/gatewayEvents/subscriptions

Quando Usar:

Para visualizar todas as subscrições ativas ou inativas no sistema.
Para buscar subscrições relacionadas a um tipo específico de dispositivo (TP, SN, RF, CT, BM).

Obter subscrições por filtro

get

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 consulta

EventTypeCodestringOpcional

ServerIpAddressstringOpcional

Portinteger · int32Opcional

ServicestringOpcional

PageSizeinteger · int32ObrigatórioDefault: 10

PageNumberinteger · int32ObrigatórioDefault: 1

EnabledbooleanOpcionalDefault: true

SortOrderstringOpcionalDefault: asc

SortFieldstringObrigatórioDefault: id

ValuestringOpcional

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

get

/api/v1/gatewayEvents/subscriptions

GET /api/v1/gatewayEvents/subscriptions?PageSize=10&PageNumber=1&SortField=id HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "serverIpAddress": "text",
        "port": 1,
        "service": "text",
        "eventType": "AccessByEnrolledTriggerDevice",
        "expiresAt": "2026-01-20T17:28:26.013Z",
        "requestUri": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Criar Nova Subscrição

Descrição:

Cria uma ou mais novas subscrições no sistema para receber eventos de tipos específicos de dispositivos acionadores, configurando os parâmetros de notificação.

POST /api/v1/gatewayEvents/subscriptions

Quando Usar:

Ao configurar o sistema para monitorar novos tipos de eventos ou dispositivos acionadores.
Para registrar múltiplos tipos de subscrição (como RF, CT, SN ) em uma única chamada de API.
Para estabelecer um novo canal de comunicação para o recebimento de notificações de eventos.

Criar nova subscrição para receber eventos de um ou mais tipos de dispositivo acionador

post

Criar nova subscrição para receber eventos de um ou mais tipos de dispositivo acionador

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 consulta

cultureNamestringOpcional

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

Default: en-US

Corpo

serverIpAddressstring · mín: 1Obrigatório

portinteger · int32Opcional

servicestring | nuloOpcional

expiresAtstring · date-time | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/gatewayEvents/subscriptions

POST /api/v1/gatewayEvents/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "serverIpAddress": "text",
  "port": 1,
  "service": "text",
  "expiresAt": "2026-01-20T17:28:26.013Z",
  "eventTypes": [
    "AccessByEnrolledTriggerDevice"
  ]
}

{
  "success": true,
  "failure": true,
  "data": [
    {
      "id": 1,
      "isEnabled": true,
      "serverIpAddress": "text",
      "port": 1,
      "service": "text",
      "eventType": "AccessByEnrolledTriggerDevice",
      "expiresAt": "2026-01-20T17:28:26.013Z",
      "requestUri": "text"
    }
  ]
}

3. Remover Todas as Subscrições por Tipo

Descrição:

Remove todas as subscrições de eventos associadas a um tipo de dispositivo acionador específico.

DELETE /api/v1/gatewayEvents/subscriptions

Quando Usar:

Para desativar completamente o recebimento de eventos de um determinado tipo de dispositivo.
Para limpar configurações de subscrição em massa para um tipo de equipamento.

Remover todas as subscrições de um tipo de dispositivo acionador específico

delete

Remover todas as subscrições de um tipo de dispositivo acionador específico

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 consulta

eventTypestring · enumObrigatório

Tópicos a remover

Valores possíveis:

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

400

Bad Request

application/json

delete

/api/v1/gatewayEvents/subscriptions

DELETE /api/v1/gatewayEvents/subscriptions?eventType=AccessByEnrolledTriggerDevice HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}

4. Obter Subscrição por ID

Descrição:

Retorna as informações detalhadas de uma subscrição de evento específica, identificada pelo seu ID único no sistema.

GET /api/v1/gatewayEvents/subscriptions/{id}

Quando Usar:

Para consultar os detalhes de configuração de uma subscrição individual.
Para exibir as informações de uma subscrição em uma tela de gerenciamento ou relatório.

Obter subscrição pelo id

get

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

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

application/json

get

/api/v1/gatewayEvents/subscriptions/{id}

GET /api/v1/gatewayEvents/subscriptions/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "serverIpAddress": "text",
    "port": 1,
    "service": "text",
    "eventType": "AccessByEnrolledTriggerDevice",
    "expiresAt": "2026-01-20T17:28:26.013Z",
    "requestUri": "text"
  }
}

5. Atualizar Subscrição Existente

Descrição:

Atualiza os parâmetros de uma subscrição de evento existente, identificada pelo seu ID, modificando as configurações de notificação ou o tipo de evento monitorado.

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

Quando Usar:

Para modificar o tipo de evento ou os parâmetros de notificação de uma subscrição já cadastrada.
Para ajustar as configurações de uma subscrição sem precisar recriá-la.

Atualizar subscrição existente

put

Atualizar subscrição existente

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

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

serverIpAddressstring · mín: 1Obrigatório

portinteger · int32Opcional

servicestring | nuloOpcional

eventTypestring · enumOpcionalValores possíveis:

expiresAtstring · date-time | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/gatewayEvents/subscriptions/{id}

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

{
  "serverIpAddress": "text",
  "port": 1,
  "service": "text",
  "eventType": "AccessByEnrolledTriggerDevice",
  "expiresAt": "2026-01-20T17:28:26.013Z"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "serverIpAddress": "text",
    "port": 1,
    "service": "text",
    "eventType": "AccessByEnrolledTriggerDevice",
    "expiresAt": "2026-01-20T17:28:26.013Z",
    "requestUri": "text"
  }
}

6. Remover Subscrição por ID

Descrição:

Remove uma subscrição de evento específica do sistema, identificada pelo seu ID único.

DELETE /api/v1/gatewayEvents/subscriptions/{id}

Quando Usar:

Ao desativar uma subscrição de evento que não é mais necessária.
Para limpar configurações de subscrição de forma granular.

Remover subscrição

delete

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

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

application/json

400

Bad Request

application/json

delete

/api/v1/gatewayEvents/subscriptions/{id}

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

{
  "success": true,
  "failure": true,
  "data": true
}

7. Criar Subscrições para Todos os Tipos de Dispositivos

Descrição:

Cria subscrições para todos os tipos de dispositivos acionadores disponíveis no sistema com uma única chamada, configurando os parâmetros de notificação.

POST /api/v1/gatewayEvents/subscriptions/allTypes

Quando Usar:

Para configurar rapidamente o monitoramento de todos os eventos de dispositivos disponíveis sem precisar especificá-los um a um.
Ao inicializar um ambiente que precisa receber notificações de todos os tipos de acionadores.

Criar subscrições para receber eventos de todos os tipos de dispositivo acionador disponíveis

post

Criar subscrições para receber eventos de todos os tipos de dispositivo acionador disponíveis: RF (Controle remoto), CT (Cartão), BM (Biometria), TP (Tag Passiva), SN (Senha)

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 consulta

cultureNamestringOpcional

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

Default: en-US

Corpo

serverIpAddressstring · mín: 1Obrigatório

portinteger · int32Opcional

servicestring | nuloOpcional

expiresAtstring · date-time | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/gatewayEvents/subscriptions/allTypes

POST /api/v1/gatewayEvents/subscriptions/allTypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "serverIpAddress": "text",
  "port": 1,
  "service": "text",
  "expiresAt": "2026-01-20T17:28:26.013Z"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "serverIpAddress": "text",
    "port": 1,
    "service": "text",
    "eventTypes": [
      "AccessByEnrolledTriggerDevice"
    ],
    "expiresAt": "2026-01-20T17:28:26.013Z",
    "ids": [
      1
    ]
  }
}

8. Remover Todas as Subscrições

Descrição:

Remove todas as subscrições de eventos de todos os tipos de dispositivos acionadores do sistema de uma só vez.

DELETE /api/v1/gatewayEvents/subscriptions/allTypes

Quando Usar:

Para desativar completamente o recebimento de todas as notificações de eventos.
Ao realizar uma limpeza geral ou redefinir as configurações de subscrição do sistema.

Remover todas as subscrições de todos os tipos de dispositivo acionador

delete

Remover todas as subscrições de todos os tipos de dispositivo acionador

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 consulta

cultureNamestringOpcionalDefault: en-US

Respostas

200

application/json

400

Bad Request

application/json

delete

/api/v1/gatewayEvents/subscriptions/allTypes

DELETE /api/v1/gatewayEvents/subscriptions/allTypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}

AnteriorPortal de Eventos PróximoCaptura de Leituras

Atualizado há 1 mês

hashtag1. Obter Subscrições por Filtro

hashtagDescrição:

hashtagQuando Usar:

hashtagObter subscrições por filtro

hashtag2. Criar Nova Subscrição

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar nova subscrição para receber eventos de um ou mais tipos de dispositivo acionador

hashtag3. Remover Todas as Subscrições por Tipo

hashtagDescrição:

hashtagQuando Usar:

hashtagRemover todas as subscrições de um tipo de dispositivo acionador específico

hashtag4. Obter Subscrição por ID

hashtagDescrição:

hashtagQuando Usar:

hashtagObter subscrição pelo id

hashtag5. Atualizar Subscrição Existente

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar subscrição existente

hashtag6. Remover Subscrição por ID

hashtagDescrição:

hashtagQuando Usar:

hashtagRemover subscrição

hashtag 7. Criar Subscrições para Todos os Tipos de Dispositivos

hashtagDescrição:

hashtagQuando Usar:

hashtagCriar subscrições para receber eventos de todos os tipos de dispositivo acionador disponíveis

hashtag 8. Remover Todas as Subscrições

hashtagDescrição:

hashtagQuando Usar:

hashtagRemover todas as subscrições de todos os tipos de dispositivo acionador

1. Obter Subscrições por Filtro

Descrição:

Quando Usar:

Obter subscrições por filtro

2. Criar Nova Subscrição

Descrição:

Quando Usar:

Criar nova subscrição para receber eventos de um ou mais tipos de dispositivo acionador

3. Remover Todas as Subscrições por Tipo

Descrição:

Quando Usar:

Remover todas as subscrições de um tipo de dispositivo acionador específico

4. Obter Subscrição por ID

Descrição:

Quando Usar:

Obter subscrição pelo id

5. Atualizar Subscrição Existente

Descrição:

Quando Usar:

Atualizar subscrição existente

6. Remover Subscrição por ID

Descrição:

Quando Usar:

Remover subscrição

7. Criar Subscrições para Todos os Tipos de Dispositivos

Descrição:

Quando Usar:

Criar subscrições para receber eventos de todos os tipos de dispositivo acionador disponíveis

8. Remover Todas as Subscrições

Descrição:

Quando Usar:

Remover todas as subscrições de todos os tipos de dispositivo acionador