CRUD e Gerenciamento

Esta seção concentra os endpoints responsáveis pelo ciclo de vida dos controladores de acesso MG3000: criação, consulta, atualização e desativação. Esses recursos permitem que o sistema cadastre novos dispositivos, consulte os já existentes com filtros ou por ID específico, atualize suas configurações e, quando necessário, os desative logicamente.

1. Obter Controladores por Filtro

Descrição:

Retorna uma lista paginada de controladores de acesso cadastrados, com opção de aplicar filtros por nome, status e outros atributos.

• GET /api/v1/accessControllers

Quando Usar:

Use este endpoint para visualizar todos os controladores disponíveis no sistema ou localizar dispositivos específicos com base em filtros.

Obter os controladores de acesso 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

IpAddressstringOpcional

DescriptionstringOpcional

EquipmentstringOpcional

ModelstringOpcional

LocalstringOpcional

StartDatestring · date-timeOpcional

EndDatestring · date-timeOpcional

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/accessControllers

HTTPcURLJavaScriptPython

GET /api/v1/accessControllers?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,
        "ipAddress": "text",
        "port": 1,
        "passcode": "text",
        "description": "text",
        "createdAt": "2026-01-20T17:29:17.920Z",
        "instance": 1,
        "model": "text",
        "local": "text",
        "equipment": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

---

2. Criar Novo Controlador

Descrição:

Permite cadastrar um novo controlador de acesso MG3000, informando nome, IP, porta de comunicação e descrição.

• POST /api/v1/accessControllers

Quando Usar:

Utilize quando for necessário adicionar um novo controlador à rede, configurando os parâmetros iniciais de comunicação.

Criar novo controlador de acesso MG3000

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

ipAddressstring | nuloOpcional

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/accessControllers

HTTPcURLJavaScriptPython

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

{
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-20T17:29:17.920Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

3. Obter Controlador por ID

Descrição:

Retorna os detalhes de um controlador de acesso específico, com base no seu ID.

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

Quando Usar:

Ideal para acessar as informações completas de um controlador já existente, como parte de um processo de revisão ou atualização.

Obter o controlador de acesso MG3000 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/accessControllers/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-20T17:29:17.920Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

4. Atualizar Controlador

Descrição:

Atualiza os dados de um controlador previamente cadastrado, como IP, nome, porta ou descrição.

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

Quando Usar:

Recomenda-se quando há necessidade de modificar a configuração de um controlador devido a mudanças na rede ou na infraestrutura física.

Atualizar controlador de acesso MG3000

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

ipAddressstring | nuloOpcional

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/accessControllers/{id}

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-20T17:29:17.920Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

5. Desabilitar Controlador

Descrição:

Desativa logicamente um controlador MG3000, impedindo seu uso sem removê-lo permanentemente da base de dados.

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

Quando Usar:

Aplique quando o controlador não estiver mais em operação ou precisar ser retirado temporariamente do sistema.

Desabilitar controlador de acesso MG3000

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/accessControllers/{id}

HTTPcURLJavaScriptPython

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

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