Master Tags

As Master Tags são duas etiquetas especiais que, ao serem lidas pela Antena, realizam operação de cadastro (Enroll) ou remoção (Delete) da Tag do usuário, oferecendo uma maneira prática e segura de executar comandos sem necessidade de interface externa.

1. Obter Master Tag (por Instância)

Descrição:

Consulta a Master Tag configurada na antena, utilizando a instância ativa do dispositivo.

• GET /api/v1/vehicleAntennas/instances/{id}/masterTags

Quando Usar:

• Para verificar se uma Master Tag está definida.

• Durante manutenções preventivas ou inspeções técnicas.

Obter a master tag da antena de tag veicular por Instância conectada

get

Obter a master tag da antena de tag veicular 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 rota

idinteger · int32Obrigatório

Id da antena de tag veicular

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 obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/instances/{id}/masterTags

HTTPcURLJavaScriptPython

GET /api/v1/vehicleAntennas/instances/{id}/masterTags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "enrollTag": "text",
    "deleteTag": "text"
  }
}

---

2. Atualizar Master Tag (por Instância)

Descrição:

Define ou substitui a Master Tag da antena, utilizando a instância ativa do dispositivo.

• POST /api/v1/vehicleAntennas/instances/{id}/masterTags

Quando Usar:

• Ao entregar o sistema para o cliente final.

• Para substituir uma Master Tag comprometida ou extraviada.

Atualizar as master tags da antena de tag veicular por Instância conectada

post

Atualizar as master tags da antena de tag veicular 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 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

application/jsontext/jsonapplication/*+json

enrollTagstring | nuloOpcional

deleteTagstring | nuloOpcional

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/instances/{id}/masterTags

HTTPcURLJavaScriptPython

POST /api/v1/vehicleAntennas/instances/{id}/masterTags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "enrollTag": "text",
  "deleteTag": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "enrollTag": "text",
    "deleteTag": "text"
  }
}

---

3. Obter Master Tag (por ID)

Descrição:

Consulta a Master Tag configurada na antena, utilizando o ID do dispositivo cadastrado.

• GET /api/v1/vehicleAntennas/{id}/masterTags

Quando Usar:

• Para auditorias ou gestão de configurações em larga escala.

• Quando não há conexão ativa com a antena.

Obter a master tag da antena de tag veicular

get

Obter a master tag da antena de tag veicular

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 da antena de tag veicular

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 obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/{id}/masterTags

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "failure": true,
  "data": {
    "enrollTag": "text",
    "deleteTag": "text"
  }
}

---

4. Atualizar Master Tag (por ID)

Descrição:

Define ou substitui a Master Tag utilizando o ID do dispositivo cadastrado.

• POST /api/v1/vehicleAntennas/{id}/masterTags

Quando Usar:

• Para reconfiguração de dispositivos sem acesso direto.

• Como parte de processos de padronização em redes maiores.

Atualizar as master tags da antena de tag veicular

post

Atualizar as master tags da antena de tag veicular

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 · int32Obrigatório

Id da antena de tag veicular

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

enrollTagstring | nuloOpcional

deleteTagstring | nuloOpcional

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/{id}/masterTags

HTTPcURLJavaScriptPython

POST /api/v1/vehicleAntennas/{id}/masterTags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "enrollTag": "text",
  "deleteTag": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "enrollTag": "text",
    "deleteTag": "text"
  }
}