Chips

Listar Chips

GET /v2/chips

Parâmetro	Descrição
attributes	Especifica quais atributos buscar. Pode incluir valores como 'serial', 'number', 'carrier', 'service_provider' e 'batch'. Se nulo, busca todas as informações.
includes	Especifica as entidades relacionadas a serem incluídas na consulta. Contém arrays para 'device' e 'enterprise', cada um com seu próprio conjunto de valores possíveis, como 'name', 'imei', 'code' para o array 'device', e 'name', 'cnpj' para o array 'enterprise'.
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 busca com um comprimento máximo de 100 caracteres.
limit	Especifica o número máximo de resultados a retornar. 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 o total de resultados na resposta.
sort	Especifica critérios de classificaçã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 Chip

POST /v2/chips

Dados de Envio

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

Campo	Descrição	Obrigatório
data	Array de objetos contendo atributos de dados e relacionamentos.	sim
attributes	Objeto contendo atributos relacionados aos dados.	sim
- serial	String com o número de série dos dados. Deve ter no máximo 20 caracteres, composto apenas por dígitos.	sim
- number	String com o atributo de número dos dados. Deve ter no máximo 20 caracteres, composto apenas por dígitos.	sim
- carrier	String com o atributo de operadora dos dados. Pode conter no máximo 255 caracteres.	não
- service_provider	String com o atributo de provedor de serviços dos dados. Deve ter no máximo 50 caracteres.	sim
- batch	String com o atributo de lote dos dados. Pode conter no máximo 50 caracteres.	não
relationships	Objeto contendo dados de relacionamento.	não
- enterprise	Objeto que representa o relacionamento com uma empresa.	não
- type	String com o tipo de relacionamento.	sim
- id	String com o ID da empresa. Deve ter 15 caracteres, composto por caracteres alfanuméricos (letras maiúsculas e minúsculas e dígitos).	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta Padrão
400	Solicitação Inválida	Um de 'Chip Already Exists', 'Chip Enterprise Data Required' ou 'Validation Failed'

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

Excluir Chips

DELETE /v2/chips

Dados de Envio

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

Campo	Descrição	Obrigatório
data	Array contendo objetos representando itens de dados a serem excluídos.
type	String que especifica o tipo de dados a serem excluídos.	sim
id	String com um comprimento de 15 caracteres alfanuméricos (letras maiúsculas e minúsculas e dígitos).	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Bad Request', 'Cannot Delete Chip(s)', 'Softruck Chip's Cannot Be Deleted'
401	Unauthorized	Não Autorizado
404	Not Found	Não Encontrado

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

Mostrar Chip

GET /v2/chips/{id}

Parâmetro	Descrição
attributes	Um array de strings especificando os atributos dos chips a serem retornados na resposta, como 'serial', 'number', 'carrier', 'service_provider' e 'batch'.
includes	Especifica entidades relacionadas a serem incluídas na consulta. Contém arrays para 'device' e 'enterprise' com valores como 'name', 'imei', 'code', 'cnpj'.

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Solicitação Inválida
401	Unauthorized	Não Autorizado
404	Not Found	Não Encontrado

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

Atualizar Chips

PATCH /v2/chips/{id}

Dados de Envio útil

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

Campo	Descrição	Obrigatório
data	Array de objetos contendo atributos e relações de dados.	sim
attributes	Objeto contendo atributos relacionados aos dados.	sim
- serial	String com o número de série dos dados. Deve ter no máximo 20 caracteres, consistindo apenas de dígitos.	sim
- number	String com o atributo de número dos dados. Deve ter no máximo 20 caracteres, consistindo apenas de dígitos.	sim
- carrier	String com o atributo de operadora dos dados. Pode conter até 255 caracteres.	falso
- service_provider	String com o atributo de provedor de serviços dos dados. Deve ter no máximo 50 caracteres.	sim
- batch	String com o atributo de lote dos dados. Pode conter até 50 caracteres.	não
relationships	Objeto contendo dados de relacionamento.	não
- enterprise	Objeto que representa o relacionamento com uma empresa.	não
- type	String com o tipo de relacionamento.	sim
- id	String com o ID da empresa. Deve ter um comprimento de 15 caracteres, consistindo em caracteres alfanuméricos (letras maiúsculas e minúsculas e dígitos).	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Bad Request', 'Cannot Update Chip(s)', 'Cannot Update Chip`s Enterprise With a Not Child Enterprise Owner'
401	Unauthorized	Não Autorizado

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

Autenticação Dispositivos