Rotas

A entidade Route define os caminhos ou permissões de acesso dentro do sistema, representando os fluxos autorizados entre dispositivos e pessoas. As rotas controlam quais acessos são permitidos a partir de determinado acionamento ou regra, sendo fundamentais para o gerenciamento lógico do controle de acesso.

1. Obter rotas por filtro

Descrição:

Retorna uma lista de rotas de acesso existentes com base nos filtros aplicados.

• GET /api/v1/routes

Quando Usar:

• Para consultar rotas cadastradas.

• Em telas de gerenciamento ou auditoria de regras de passagem.

Obter rotas por filtro

get

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

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

OK

application/json

get

/api/v1/routes

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "routeCode": 1,
        "routeDescription": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

2. Cria nova rota

Descrição:

Cria uma nova rota de acesso no sistema.

• POST /api/v1/routes

Quando Usar:

• Para cadastrar novos fluxos de passagem (ex: entrada de funcionários, saída de visitantes).

• Ao configurar novas regras de autorização entre pessoas e dispositivos.

Cria nova rota

post

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

cultureNamestringOpcional

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

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

routeCodeinteger · int32Opcional

routeDescriptionstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

post

/api/v1/routes

HTTPcURLJavaScriptPython

POST /api/v1/routes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "routeCode": 1,
  "routeDescription": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "routeCode": 1,
    "routeDescription": "text"
  }
}

3. Obter rota por id

Descrição:

Retorna os dados de uma rota específica, identificada pelo seu ID.

• GET /api/v1/routes/{id}

Quando Usar:

• Para visualizar detalhes de uma rota antes de editá-la ou removê-la.

• Para exibir dados completos em interfaces administrativas.

Obter rota pelo id

get

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

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

get

/api/v1/routes/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "routeCode": 1,
    "routeDescription": "text"
  }
}

4. Atualiza rota por id

Descrição:

Atualiza os dados de uma rota existente, identificada pelo ID.

• PUT /api/v1/routes/{id}

Quando Usar:

• Para alterar nome, descrição ou configuração lógica da rota.

• Durante ajustes operacionais no fluxo de acesso.

Atualiza rota

put

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

cultureNamestringOpcional

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

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

idinteger · int64Opcional

routeCodeinteger · int32Opcional

routeDescriptionstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/routes/{id}

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "routeCode": 1,
  "routeDescription": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "routeCode": 1,
    "routeDescription": "text"
  }
}

5. Desabilita rota por id

Descrição:

Desabilita logicamente uma rota de acesso.

• DELETE /api/v1/routes/{id}

Quando Usar:

• Para revogar o uso de uma rota sem removê-la permanentemente do sistema.

• Durante bloqueios operacionais ou manutenção.

Desabilita rota

delete

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

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

delete

/api/v1/routes/{id}

HTTPcURLJavaScriptPython

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

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

6. Habilita rota

Descrição:

Habilita uma rota anteriormente desabilitada, restaurando seu uso no sistema.

• PUT /api/v1/routes/{id}/enablements

Quando Usar:

• Para reativar uma rota já existente.

• Durante reconfiguração ou reabertura de fluxos.

Habilita rota

put

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

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

put

/api/v1/routes/{id}/enablements

HTTPcURLJavaScriptPython

PUT /api/v1/routes/{id}/enablements HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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