Chips

Listar Chips

GET /v2/chips

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 admite 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 devolver. 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 recuento 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

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	Bad Request

Esta operación no requiere autenticación

Create Chip

POST /v2/chips

Datos de Envío

{
  "body": {
    "data": [
      {
        "attributes": {
          "serial": "8996543747544368975",
          "number": "55319938457737",
          "carrier": "Softruck",
          "service_provider": "Vivo",
          "batch": "Batch 13"
        },
        "relationships": {
          "enterprise": {
            "type": "enterprise",
            "id": "123456789012345"
          }
        }
      }
    ]
  }
}

Campo	Descripción	Requerido
data	Array de objetos que contienen atributos de datos y relaciones.	sí
attributes	Objeto que contiene atributos relacionados con los datos.	sí
- serial	String con el número de serie de los datos. Debe tener una longitud máxima de 20 caracteres, compuesta solo por dígitos.	sí
- number	String con el atributo de número de los datos. Debe tener una longitud máxima de 20 caracteres, compuesta solo por dígitos.	sí
- carrier	String con el atributo de operador de los datos. Puede contener una longitud máxima de 255 caracteres.	no
- service_provider	String con el atributo de proveedor de servicios de los datos. Debe tener una longitud máxima de 50 caracteres.	sí
- batch	String con el atributo de lote de los datos. Puede contener una longitud máxima de 50 caracteres.	no
relationships	Objeto que contiene datos de relación.	no
- enterprise	Objeto que representa la relación con una empresa.	no
- type	String con el tipo de relación.	sí
- id	String con el ID de la empresa. Debe tener una longitud de 15 caracteres, compuesta por caracteres alfanuméricos (letras mayúsculas y minúsculas y dígitos).	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta predeterminada
400	Solicitud incorrecta	Uno de 'Chip Already Exists', 'Chip Enterprise Data Required' o 'Validation Failed'

Esta operación no requiere autenticación

Excluir Chips

DELETE /v2/chips

Datos de Envío

{
  "body": {
    "data": [
      {
        "type": "chips",
        "id": "ABC1234567890DEF"
      },
      {
        "type": "chips",
        "id": "GHI9876543210JKL"
      }
    ]
  }
}

Campo	Descripción	Obrigatório
data	Array que contiene objetos que representan elementos de datos a serem eliminados.
type	String que especifica el tipo de datos a eliminar.	sí
id	String con una longitud de 15 caracteres alfanuméricos (letras mayúsculas y minúsculas y dígitos).	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request', 'Cannot Delete Chip(s)', 'Softruck Chip's Cannot Be Deleted'
401	Unauthorized	No Autorizado
404	Not Found	No Encontrado

Esta operación no requiere autenticación

Mostrar Chip

GET /v2/chips/{id}

Parámetro	Descripción
attributes	Un array de Strings que especifica los atributos de los chips que se devolverán en la respuesta, como 'serial', 'number', 'carrier', 'service_provider' y 'batch'.
includes	Especifica entidades relacionadas para incluir en la consulta. Contiene matrices para 'device' y 'enterprise' con valores como 'name', 'imei', 'code', 'cnpj'.

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud Inválida
401	Unauthorized	No Autorizado
404	Not Found	No Encontrado

Esta operación no requiere autenticación

Actualizar Chips

PATCH /v2/chips/{id}

Datos de Envío

{
  "body": {
    "data": {
      "attributes": {
        "serial": "12345678901234567890",
        "number": "55319938457737",
        "carrier": "Softruck",
        "service_provider": "Vivo",
        "batch": "Lote 13"
      },
      "relationships": {
        "enterprise": {
          "type": "enterprise",
          "id": "123456789012345"
        }
      }
    }
  }
}

Campo	Descripción	Obligatorio
data	Array de objetos que contienen atributos y relaciones de datos.	sí
atributos	Objeto que contiene atributos relacionados a los datos.	sí
- serial	String con el número de serie de los datos. Debe tener un máximo de 20 caracteres, consistiendo únicamente en dígitos.	sí
- number	String con el atributo de número de los datos. Debe tener un máximo de 20 caracteres, consistiendo únicamente en dígitos.	sí
- carrier	String con el atributo de operadora de los datos. Puede contener hasta 255 caracteres.	no
- service_provider	String con el atributo de proveedor de servicios de los datos. Debe tener un máximo de 50 caracteres.	sí
- batch	String con el atributo de lote de los datos. Puede contener hasta 50 caracteres.	no
relaciones	Objeto que contiene datos de relación.	no
- enterprise	Objeto que representa la relación con una empresa.	no
- type	String con el tipo de relación.	sí
- id	String con el ID de la empresa. Debe tener una longitud de 15 caracteres, consistiendo en caracteres alfanuméricos (letras mayúsculas y minúsculas y dígitos).	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request', 'Cannot Update Chip(s)', 'Cannot Update Chip`s Enterprise With a Not Child Enterprise Owner'
401	Unauthorized	No Autorizado

Esta operación no requiere autenticación

Autenticación Dispositivos