Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
Ambos lados da revisão anterior Revisão anterior Próxima revisão | Revisão anterior Próxima revisão Ambos lados da revisão seguinte | ||
api_flashman [03/07/2018 04:30] superuser |
api_flashman [29/01/2019 17:21] 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 112: | 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 156: | 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 179: | 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 233: | 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 282: | Linha 335: | ||
| Comando | Tipo de comando a ser desempenhado pelo roteador Flashbox | Veja os comandos suportados logo abaixo | Sim | | | Comando | Tipo de comando a ser desempenhado pelo roteador Flashbox | Veja os comandos suportados logo abaixo | Sim | | ||
- | ^ Comando ^ Descrição ^ | + | ^ Comando ^ Descrição ^ |
- | | boot | Reiniciar roteador Flashbox | | + | | boot | Reiniciar roteador Flashbox | |
- | | rstapp | Apagar senha de login do aplicativo do usuário final | | + | | 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 | | + | | rstmqtt | Cuidado! Gera um novo token MQTT. Apenas use esse comando após a remoção do cadastro do roteador no Flashman | |
- | | log | Ativa/desativa o envio de log em tempo real do roteador para o Flashman. Para ver o log, use o comando de coletar log simultâneo | | + | | 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 == | == Retorno da Requisição == | ||
- | ^ Status Code ^ Descrição ^ | + | ^ Status Code ^ Descrição ^ |
- | | 200 | OK, comando executado com sucesso | | + | | 200 | OK, comando executado com sucesso | |
- | | 500 | Erro interno do servidor | | + | | 500 | Erro interno do servidor | |
- | | 404 | Comando ou roteador não encontrado | | + | | 404 | Comando ou roteador não encontrado | |
== Exemplos de Retorno == | == Exemplos de Retorno == | ||
Linha 299: | Linha 352: | ||
"success": true | "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> |