Essa é uma revisão anterior do documento!

Autenticação

Todos os métodos da API necessitam de autenticação. É possível utilizar o usuário e senha de acesso via Web.

Tipo da autenticação: Basic Auth

Métodos

Consultar informações de um roteador

Formato da URL
/devicelist/update/{MAC do roteador}
Método HTTP
GET
Formato da Requisição
Parâmetro Descrição Formato Obrigatório
MAC do roteador Endereço MAC do roteador que encontra-se na etiqueta do equipamento [A-F]:[A-F]:[A-F]:[A-F]:[A-F]:[A-F] Sim
Retorno da Requisição
Status Code Descrição
200 OK, retorna as informações do roteador
404 Roteador não encontrado
500 Erro interno do servidor
Exemplos de Retorno
{
  "success": false,
  "message": "device not found"
}
{
  "success": true,
  "external_reference": {
      "kind": 'CPF',
      "data": '123.456.789-00'
  },
  "apps": [],
  _id: '11:11:11:11:11:11',
  "model": 'TL-MR3020V1',
  "release": '0004-AIX',
  "pppoe_user": '',
  "pppoe_password": '',
  "wifi_ssid": 'TesteSSID',
  "wifi_password": 'SenhaWifi',
  "wifi_channel": 'auto',
  "last_contact": 2018-01-01T03:00:00.000Z,
  "do_update": false,
  "do_update_parameters": true,
  "__v": 0
}

Alterar informações de um roteador

Formato da URL
/devicelist/update/{MAC do roteador}
Método HTTP
PUT
Formato da Requisição
Parâmetro Descrição Formato Obrigatório
MAC do roteador Endereço MAC do roteador que encontra-se na etiqueta do equipamento [A-F]:[A-F]:[A-F]:[A-F]:[A-F]:[A-F] Sim
Parâmetros do Body
Parâmetro Descrição Formato Obrigatório
pppoe_user Usuário PPPoE String Não
pppoe_password Senha do usuário PPPoE String Não
wifi_ssid Identificação do ponto de acesso sem fio do usuário (SSID) String Não
wifi_password Senha do ponto de acesso sem fio do usuário String Não
wifi_channel Canal do 802.11 String Não
Exemplo do Body
{
  "content": {
    "pppoe_user": "teste",
    "pppoe_password": "teste123",
    "wifi_ssid": "FlashMan-AP-Teste",
    "wifi_password": "senhateste",
    "wifi_channel": "auto"
  }
}
Retorno da Requisição
Status Code Descrição
200 OK, retorna as informações do roteador alterado
404 Roteador não encontrado
500 Erro no servidor, mais informações no body da mensagem de retorno
Exemplos de Retorno
{
  "success": false,
  "message": "device not found",
  "errors": []
}
{
  "success": true,
  "external_reference": {
      "kind": 'CPF',
      "data": '123.456.789-00'
  },
  "apps": [],
  _id: '11:11:11:11:11:11',
  "model": 'TL-MR3020V1',
  "release": '0004-AIX',
  "pppoe_user": '',
  "pppoe_password": '',
  "wifi_ssid": 'TesteSSID',
  "wifi_password": 'SenhaWifi',
  "wifi_channel": 'auto',
  "last_contact": 2018-01-01T03:00:00.000Z,
  "do_update": false,
  "do_update_parameters": true,
  "__v": 0
}
{
  "success": false,
  "message": 'Erro validando os campos, ver campo "errors"',
  "errors": [
    "password": "Este campo deve ter no mínimo 8 caracteres"
  ]
}

Remover registro de roteador

Formato da URL
/devicelist/delete/{MAC do roteador}
Método HTTP
DELETE
Formato da Requisição
Parâmetro Descrição Formato Obrigatório
MAC do roteador Endereço MAC do roteador que encontra-se na etiqueta do equipamento [A-F]:[A-F]:[A-F]:[A-F]:[A-F]:[A-F] Sim
Retorno da Requisição
Status Code Descrição
200 OK, roteador foi deletado com sucesso
500 Erro interno do servidor
Exemplos de Retorno
{
  "success": true
}

Criar registro de um roteador

Formato da URL
/devicelist/create
Método HTTP
PUT
Parâmetros do Body
Parâmetro Descrição Formato Obrigatório
mac_address Endereço MAC do roteador que encontra-se na etiqueta do equipamento [A-F]:[A-F]:[A-F]:[A-F]:[A-F]:[A-F] Sim
release Identificador de release do firmware. Exemplo: 0001-fab String Não
pppoe_user Usuário PPPoE String Não
pppoe_password Senha do usuário PPPoE String Não
wifi_ssid Identificação do ponto de acesso sem fio do usuário (SSID) String Não
wifi_password Senha do ponto de acesso sem fio do usuário String Não
wifi_channel Canal do 802.11 String Não
Exemplo do Body
{
  "content": {
    "mac_address": "FF:FF:FF:00:00:00",
    "release": "0001-fab",
    "pppoe_user": "teste",
    "pppoe_password": "teste123",
    "wifi_ssid": "FlashMan-AP-Teste",
    "wifi_password": "senhateste",
    "wifi_channel": "auto"
  }
}
Retorno da Requisição
Status Code Descrição
200 OK, roteador criado com sucesso
500 Erro no servidor, mais informações no body da mensagem de retorno
Exemplos de Retorno
{
  "success": false,
  "message": "Erro no json recebido",
  "errors": []
}
{
  "success": true,
}
{
  "success": false,
  "message": 'Erro validando os campos, ver campo "errors"',
  "errors": [
    "password": "Este campo deve ter no mínimo 8 caracteres"
  ]
}