Dispositivos

Listar Dispositivos

GET /v2/devices

Parámetro	Descripción
attributes	Especifica qué atributos recuperar. Puede incluir valores como 'serial', 'number', 'carrier', 'service_provider' y 'batch'. Si es nulo, recupera toda la información.
includes	Especifica las entidades relacionadas para incluir en la consulta. Contiene array para 'device' y 'enterprise', cada uno con su propio conjunto de valores posibles, como 'name', 'imei', 'code' para el array 'device', y 'name', 'cnpj' para el array 'enterprise'.
filters	Especifica filtros para varios 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 soporta condiciones como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica la consulta de búsqueda como mucho 100 caracteres.
limit	Especifica el número máximo de resultados a ser devueltos. Debe ser un número entre 1 y 100.
page	Especifica el número de página para resultados paginados. Debe ser un número mayor o igual a 0.
count	Indica si incluir el conteo total de resultados en la respuesta.
sort	Especifica criterios de ordenación para los campos 'number' y 'serial'. Los valores pueden ser -1 (orden descendente) o 1 (orden ascendente).

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud Inválida

Esta operación no requiere autenticación

Crear Dispositivos

POST /v2/devices

Datos de Envío

{
  "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	Descripción	Obrigatório
data	Array de objetos de datos representando dispositivos.	sí
attributes	Objeto que contiene atributos del dispositivo.	sí
- name	String con el nombre del dispositivo, como mucho 21 caracteres.	sí
- imei	String con el IMEI del dispositivo, como mucho 25 caracteres, debe consistir solo en números.	sí
- batch	String con el lote del dispositivo, como mucho 50 caracteres.	no
- code	String con el código del dispositivo, como mucho 20 caracteres.	no
relationships	Objeto que contiene relaciones con otras entidades.	no
- chip	Objeto que representa la relación con un chip.	no
-- type	String con el tipo de relación, debe ser 'chip'.	sí
-- id	String con el ID del chip, debe consistir en 15 caracteres alfanuméricos.	sí
- enterprise	Objeto que representa la relación con una empresa.	no
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí
- vehicle	Objeto que representa la relación con un vehículo.	no
-- type	String con el tipo de relación, debe ser 'vehicle'.	sí
-- id	String con el ID del vehículo, debe consistir en 15 caracteres alfanuméricos.	sí
- type	Objeto que representa la relación con un tipo.	no
-- type	String con el tipo de relación, debe ser 'type'.	sí
-- id	String con el ID del tipo, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request', 'Device(s) Already Exists', 'Duplicated `names` Was Listed', 'Resource Already Exists' o 'Device(S) And Chip(S) Do Not Belong To Same Enterprise'

Esta operación no requiere autenticación

Excluir Dispositivos

DELETE /v2/devices

Datos de Envío

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

Campo	Descripción	Obrigatório
data	Array de objetos de datos representando dispositivos.
type	String con el tipo del objeto de datos, debe ser 'devices'.	sí
id	String con el ID del dispositivo, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request' o 'Device(s) Belong to Softruck'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Mostrar Dispositivo

GET /v2/devices/{id}

Campo	Descripción
query	Objeto que contiene parámetros de consulta.
- attributes	Array de atributos a ser recuperados. Puede contener valores como 'name', 'imei', 'batch', 'created_at', 'updated_at', 'code'.
- includes	Objeto que especifica qué entidades relacionadas incluir en la consulta.
-- chip	Array de atributos relacionados al chip, incluyendo 'serial', 'number', 'service_provider'.
-- last_gps	Array de atributos relacionados a los últimos datos de GPS, incluyendo 'last_connection_time', 'last_gps_time'.
-- enterprise	Array de atributos relacionados a la empresa, incluyendo 'name', 'cnpj'.
-- vehicle	Array de atributos relacionados al vehículo, incluyendo 'plate', 'vin', 'code'.
-- type	Array de atributos relacionados al tipo de dispositivo, incluyendo 'alias', 'brand_alias', 'inputs_count', 'outputs_count'.

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request' o 'Conflicted Device Found. Device A Name Equal Device B Imei'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar Dispositivo

PATCH /v2/devices/{id}

Datos de Envío

{
  "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	Descripción	Obrigatório
data	Array de objetos de datos representando dispositivos.	sí
attributes	Objeto que contiene atributos del dispositivo.	sí
- name	String con el nombre del dispositivo, como mucho 21 caracteres.	sí
- imei	String con el IMEI del dispositivo, como mucho 25 caracteres, debe consistir solo en números.	sí
- batch	String con el lote del dispositivo, como mucho 50 caracteres.	no
- code	String con el código del dispositivo, como mucho 20 caracteres.	no
relationships	Objeto que contiene relaciones con otras entidades.	no
- chip	Objeto representando la relación con un chip.	no
-- type	String con el tipo de relación, debe ser 'chip'.	sí
-- id	String con el ID del chip, debe consistir en 15 caracteres alfanuméricos.	sí
- empresa	Objeto representando la relación con una empresa.	no
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí
- vehículo	Objeto representando la relación con un vehículo.	no
-- type	String con el tipo de relación, debe ser 'vehicle'.	sí
-- id	String con el ID del vehículo, debe consistir en 15 caracteres alfanuméricos.	sí
- type	Objeto representando la relación con un tipo.	no
-- type	String con el tipo de relación, debe ser 'type'.	sí
-- id	String con el ID del tipo, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno 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' o 'Device(S) And Chip(S) Do Not Belong To Same Enterprise'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar Dispositivos {situation}

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

Parámetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situation": "activation"
  }
}

Campo	Descripción	Obrigatório
id	String que contiene el ID, debe seguir el patrón alfanumérico y tener una longitud de 15 caracteres.	sí
situation	String que indica la situación, debe ser 'activation' o 'deactivation'.	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar

Esta operación no requiere autenticación

Chips Usuarios