Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anterior Revisão anterior
Próxima revisão
Revisão anterior
api_flashman [24/05/2018 03:55]
127.0.0.1 edição externa
api_flashman [26/06/2019 00:53]
superuser
Linha 27: Linha 27:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                             
-| 200 | OK, retorna as informações do roteador |  +| 200         ​| OK, retorna as informações do roteador |  
-| 404 | Roteador não encontrado | +| 404         ​| Roteador não encontrado ​               
-| 500 | Erro interno do servidor |+| 500         ​| Erro interno do servidor ​              ​|
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 59: Linha 59:
   "​do_update":​ false,   "​do_update":​ false,
   "​do_update_parameters":​ true,   "​do_update_parameters":​ true,
-  "​__v":​ 0+  ​"​connection_type":​ '​dhcp',​ 
 +  ​"​__v":​ 0
 +  "​ip":​ '​5.5.5.5',​ 
 +  "​wan_ip":​ '​10.10.10.10'​
 } }
 </​code>​ </​code>​
Linha 109: Linha 112:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                                                        ​
-| 200 | OK, retorna as informações do roteador alterado |  +| 200         ​| OK, retorna as informações do roteador alterado ​                  ​|  
-| 404 | Roteador não encontrado | +| 404         ​| Roteador não encontrado ​                                          ​
-| 500 | Erro no servidor, mais informações no body da mensagem de retorno |+| 500         ​| Erro no servidor, mais informações no body da mensagem de retorno |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 153: Linha 156:
     "​password":​ "Este campo deve ter no mínimo 8 caracteres"​     "​password":​ "Este campo deve ter no mínimo 8 caracteres"​
   ]   ]
 +}
 +</​code>​
 +
 +==== Habilitar ou desabilitar atualização de firmware de um roteador ====
 +
 +== Formato da URL ==
 +
 +<​code>​
 +/​devicelist/​update/​{MAC do roteador}/​{Release}
 +</​code>​
 +
 +== Método HTTP ==
 +
 +<​code>​
 +PUT
 +</​code>​
 +
 +== 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         |
 +| Release ​        | Identificador de release do firmware. Exemplo: 0001-fab ​            | String ​                             | Não         |
 +
 +== Parâmetros do Body ==
 +
 +^ Parâmetro ​      ^ Descrição ​                                                  ^ Formato ​ ^ Obrigatório ​ ^
 +| do_update ​      | Habilitar ou desabilitar a atualização de firmware ​         | Booleano | Sim          |
 +
 +== Exemplo do Body ==
 +
 +<​code>​
 +{
 +  "​do_update":​ true
 +}
 +</​code>​
 +
 +
 +== Retorno da Requisição ==
 +^ Status Code ^ Descrição ​                                                        ^
 +| 200         | OK, alteração feita com sucesso ​                                  ​| ​
 +| 500         | Erro no servidor, mais informações no body da mensagem de retorno |
 +
 +== Exemplos de Retorno ==
 +<​code>​
 +{
 +  "​success":​ false,
 +  "​message":​ "Erro ao encontrar dispositivo"​
 +}
 +</​code>​
 +
 +<​code>​
 +{
 +  "​success":​ true
 } }
 </​code>​ </​code>​
Linha 176: Linha 232:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                            ​
-| 200 | OK, roteador foi deletado com sucesso |  +| 200         ​| OK, roteador foi deletado com sucesso |  
-| 500 | Erro interno do servidor |+| 500         ​| Erro interno do servidor ​             |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 230: Linha 286:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                                                        ​
-| 200 | OK, roteador criado com sucesso |  +| 200         ​| OK, roteador criado com sucesso ​                                  ​|  
-| 500 | Erro no servidor, mais informações no body da mensagem de retorno |+| 500         ​| Erro no servidor, mais informações no body da mensagem de retorno |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 257: Linha 313:
   ]   ]
 } }
 +</​code>​
 +
 +==== Enviar comando para um roteador ====
 +
 +== Formato da URL ==
 +
 +<​code>​
 +/​devicelist/​command/​{MAC do roteador}/​{Comando}
 +</​code>​
 +
 +== Método HTTP ==
 +
 +<​code>​
 +PUT
 +</​code>​
 +
 +== 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         |
 +| Comando ​        | Tipo de comando a ser desempenhado pelo roteador Flashbox ​          | Veja os comandos suportados logo abaixo | Sim         |
 +
 +^ Comando ​ ^ Descrição ​                                                                                                    ^
 +| boot     | Reiniciar roteador Flashbox ​                                                                                  |
 +| rstapp ​  | Apagar senha de login do aplicativo do usuário final                                                          |
 +| rstmqtt ​ | Cuidado! Gera um novo token MQTT. Apenas use esse comando após a remoção do cadastro do roteador no Flashman ​ |
 +| log      | Envia o de log  do roteador para o Flashman. Para ver o log, use o comando de visualizar último log           |
 +
 +== Retorno da Requisição ==
 +^ Status Code ^ Descrição ​                            ^
 +| 200         | OK, comando executado com sucesso ​    ​| ​
 +| 500         | Erro interno do servidor ​             |
 +| 404         | Comando ou roteador não encontrado ​   |
 +
 +== Exemplos de Retorno ==
 +<​code>​
 +{
 +  "​success":​ true
 +}
 +</​code>​
 +
 +==== Visualizar último log enviado de um roteador ====
 +
 +ATENÇÂO! Use esta função após o comando de envio de log.
 +
 +== Formato da URL ==
 +
 +<​code>​
 +/​devicelist/​lastlog/​{MAC do roteador}
 +</​code>​
 +
 +== Método HTTP ==
 +
 +<​code>​
 +GET
 +</​code>​
 +
 +== 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, comando executado com sucesso ​    ​| ​
 +| 500         | Erro interno do servidor ​             |
 +| 404         | Roteador não encontrado ​              |
 +
 +== Exemplos de Retorno ==
 +<​code>​
 +{
 +  "​success":​ true,
 +  "​message":​ "Não existe log deste roteador"​
 +}
 +</​code>​
 +
 +<​code>​
 +'​Content-Encoding',​ '​gzip',​
 +'​Content-Type',​ '​text/​plain'​
 +</​code>​
 +
 +==== Visualizar log de boot de um roteador ====
 +
 +== Formato da URL ==
 +
 +<​code>​
 +/​devicelist/​firstlog/​{MAC do roteador}
 +</​code>​
 +
 +== Método HTTP ==
 +
 +<​code>​
 +GET
 +</​code>​
 +
 +== 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, comando executado com sucesso ​    ​| ​
 +| 500         | Erro interno do servidor ​             |
 +| 404         | Roteador não encontrado ​              |
 +
 +== Exemplos de Retorno ==
 +<​code>​
 +{
 +  "​success":​ true,
 +  "​message":​ "Não existe log deste roteador"​
 +}
 +</​code>​
 +
 +<​code>​
 +'​Content-Encoding',​ '​gzip',​
 +'​Content-Type',​ '​text/​plain'​
 </​code>​ </​code>​