Essa é uma revisão anterior do documento!


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

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

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"
  }
}

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

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"
  }
}