Dispositivos

Listar Dispositivos

GET /v2/devices

Parâmetro	Descrição
attributes	Especifica quais atributos recuperar. Pode incluir valores como 'serial', 'number', 'carrier', 'service_provider' e 'batch'. Se nulo, recupera todas as informações.
includes	Especifica as entidades relacionadas a serem incluídas na consulta. Contém arrays para 'device' e 'enterprise' com valores como 'name', 'imei', 'code', 'cnpj'.
filters	Especifica filtros para vários campos como 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Cada campo de filtro suporta condições como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica a consulta de pesquisa com um comprimento máximo de 100 caracteres.
limit	Especifica o número máximo de resultados a serem retornados. Deve ser um número entre 1 e 100.
page	Especifica o número da página para resultados paginados. Deve ser um número maior ou igual a 0.
count	Indica se incluir a contagem total de resultados na resposta.
sort	Especifica critérios de ordenação para os campos 'number' e 'serial'. Os valores podem ser -1 (ordem decrescente) ou 1 (ordem crescente).

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Solicitação Inválida

Esta operação não requer autenticação

Criar Dispositivos

POST /v2/devices

Dados de Envio

{
  "body": {
    "data": [
      {
        "attributes": {
          "name": "Device 1",
          "imei": "1234567890123456789012345",
          "batch": "ABC123",
          "code": "XYZ789"
        },
        "relationships": {
          "chip": {
            "type": "chip",
            "id": "abc123456789xyz"
          },
          "enterprise": {
            "type": "enterprise",
            "id": "xyz987654321abc"
          },
          "vehicle": {
            "type": "vehicle",
            "id": "123abc456def789"
          },
          "type": {
            "type": "type",
            "id": "456def789123abc"
          }
        }
      },
      {
        "attributes": {
          "name": "Device 2",
          "imei": "9876543210987654321098765"
        },
        "relationships": {
          "chip": {
            "type": "chip",
            "id": "def456789123abc"
          }
        }
      }
    ]
  }
}

Campo	Descrição	Obrigatório
data	Array de objetos de dados representando dispositivos.	sim
attributes	Objeto contendo atributos do dispositivo.	sim
- name	String com o nome do dispositivo, com no máximo 21 caracteres.	sim
- imei	String com o IMEI do dispositivo, com no máximo 25 caracteres, deve consistir apenas de números.	sim
- batch	String com o lote do dispositivo, com no máximo 50 caracteres.	não
- code	String com o código do dispositivo, com no máximo 20 caracteres.	não
relationships	Objeto contendo relacionamentos com outras entidades.	não
- chip	Objeto representando o relacionamento com um chip.	não
-- type	String com o tipo de relacionamento, deve ser 'chip'.	sim
-- id	String com o ID do chip, deve consistir de 15 caracteres alfanuméricos.	sim
- enterprise	Objeto representando o relacionamento com uma empresa.	não
-- type	String com o tipo de relacionamento, deve ser 'enterprise'.	sim
-- id	String com o ID da empresa, deve consistir de 15 caracteres alfanuméricos.	sim
- vehicle	Objeto representando o relacionamento com um veículo.	não
-- type	String com o tipo de relacionamento, deve ser 'vehicle'.	sim
-- id	String com o ID do veículo, deve consistir de 15 caracteres alfanuméricos.	sim
- type	Objeto representando o relacionamento com um tipo.	não
-- type	String com o tipo de relacionamento, deve ser 'type'.	sim
-- id	String com o ID do tipo, deve consistir de 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Bad Request', 'Device(s) Already Exists', 'Duplicated `names` Was Listed', 'Resource Already Exists' ou 'Device(S) And Chip(S) Do Not Belong To Same Enterprise'

Esta operação não requer autenticação

Excluir Dispositivos

DELETE /v2/devices

Dados de Envio

{
  "body": {
    "data": [
      {
        "type": "devices",
        "id": "abc123456789xyz"
      },
      {
        "type": "devices",
        "id": "def456789123abc"
      }
    ]
  }
}

Campo	Descrição	Obrigatório
data	Array de objetos de dados representando dispositivos.
type	String com o tipo do objeto de dados, deve ser 'devices'.	sim
id	String com o ID do dispositivo, deve consistir em 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um dos 'Bad Request' ou 'Device(s) Belong to Softruck'
401	Unauthorized	Não autorizado
404	Not Found	Não encontrado

Esta operação não requer autenticação

Mostrar Dispositivo

GET /v2/devices/{id}

Campo	Descrição
query	Objeto contendo parâmetros de consulta.
- attributes	Array de atributos a serem recuperados. Pode conter valores como 'name', 'imei', 'batch', 'created_at', 'updated_at', 'code'.
- includes	Objeto especificando quais entidades relacionadas incluir na consulta.
-- chip	Array de atributos relacionados ao chip, incluindo 'serial', 'number', 'service_provider'.
-- last_gps	Array de atributos relacionados aos últimos dados de GPS, incluindo 'last_connection_time', 'last_gps_time'.
-- enterprise	Array de atributos relacionados à empresa, incluindo 'name', 'cnpj'.
-- vehicle	Array de atributos relacionados ao veículo, incluindo 'plate', 'vin', 'code'.
-- type	Array de atributos relacionados ao tipo de dispositivo, incluindo 'alias', 'brand_alias', 'inputs_count', 'outputs_count'.

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Bad Request' ou 'Conflicted Device Found. Device A Name Equal Device B Imei'
401	Unauthorized	Não autorizado
404	Not Found	Não encontrado

Esta operação não requer autenticação

Atualizar Dispositivo

PATCH /v2/devices/{id}

Dados de Envio

{
  "body": {
    "data": {
      "attributes": {
        "name": "ExampleName",
        "imei": "1234567890123456789012345",
        "batch": "ExampleBatch",
        "code": "ExampleCode"
      },
      "relationships": {
        "chip": {
          "type": "chip",
          "id": "abc123456789012"
        },
        "enterprise": {
          "type": "enterprise",
          "id": "def456789012345"
        },
        "vehicle": {
          "type": "vehicle",
          "id": "ghi789012345678"
        },
        "type": {
          "type": "type",
          "id": "jkl901234567890"
        }
      }
    }
  }
}

Campo	Descrição	Obrigatório
data	Array de objetos de dados representando dispositivos.	sim
attributes	Objeto contendo atributos do dispositivo.	sim
- name	String com nome do dispositivo, com no máximo 21 caracteres.	sim
- imei	String com IMEI do dispositivo, com no máximo 25 caracteres, deve consistir apenas em números.	sim
- batch	String com lote do dispositivo, com no máximo 50 caracteres.	não
- code	String com código do dispositivo, com no máximo 20 caracteres.	não
relationships	Objeto contendo relacionamentos com outras entidades.	não
- chip	Objeto representando relacionamento com um chip.	não
-- type	String com o tipo de relacionamento, deve ser 'chip'.	sim
-- id	String com o ID do chip, deve consistir em 15 caracteres alfanuméricos.	sim
- enterprise	Objeto representando relacionamento com uma empresa.	não
-- type	String com o tipo de relacionamento, deve ser 'enterprise'.	sim
-- id	String com o ID da empresa, deve consistir em 15 caracteres alfanuméricos.	sim
- vehicle	Objeto representando relacionamento com um veículo.	não
-- type	String com o tipo de relacionamento, deve ser 'vehicle'.	sim
-- id	String com o ID do veículo, deve consistir em 15 caracteres alfanuméricos.	sim
- type	Objeto representando relacionamento com um tipo.	não
-- type	String com o tipo de relacionamento, deve ser 'type'.	sim
-- id	String com o ID do tipo, deve consistir em 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Bad Request', 'Cannot Update Enterprise Of Associated Device(S)', 'Devices New Enterprise Does Not Belong To Same Owner', 'Cannot Update Device(s)', 'Device(S) And Vehicle(S) Do Not Belong To Same Enterprise' ou 'Device(S) And Chip(S) Do Not Belong To Same Enterprise'
401	Unauthorized	Não autorizado
404	Not Found	Não encontrado

Esta operação não requer autenticação

Atualizar Dispositivos {situation}

PATCH /v2/devices/{id}/status/{situation}

Parâmetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situação": "activation"
  }
}

Campo	Descrição	Obrigatório
id	String contendo o ID, deve seguir o padrão alfanumérico e ter um comprimento de 15 caracteres.	sim
situation	String indicando a situação, deve ser 'activation' ou 'deactivation'.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão

Esta operação não requer autenticação

Chips Usuários