MGE/API/CmdRemoverUsuario
De uTech Tecnologia
(Diferença entre revisões)
(Criou página com ' __TOC__ O comando '''Remover todos os Usuários''' é utilizado remover a lista completa de usuários de acesso do medidor MGE. == Comando == '''MÉTODO:''' <span style="c...') |
|||
Linha 2: | Linha 2: | ||
__TOC__ | __TOC__ | ||
− | O comando '''Remover | + | O comando '''Remover usuário''' é utilizado remover um usuário no controle de acesso do medidor. Como parâmetro de remoção, pode ser utilizado um dos parâmetros listados abaixo). |
− | + | {| style="width: 100%; background-color: orange;" | |
+ | | | ||
+ | * '''Este comando DEVE ser síncrono. DEVE-SE executar e esperar sua resposta antes de enviar qualquer outro comando para o medidor'''. | ||
+ | |} | ||
== Comando == | == Comando == | ||
− | '''MÉTODO:''' <span style="color:red">''' | + | <BR\> |
+ | '''MÉTODO:''' <span style="color:red">'''POST'''</span> | ||
{| class="wikitable" width="65%" | {| class="wikitable" width="65%" | ||
! align="center" colspan="2" | Parâmetros enviados para o medidor | ! align="center" colspan="2" | Parâmetros enviados para o medidor | ||
|- | |- | ||
− | | align="left"| '''request''' || ''' | + | | align="left"| '''request''' || '''deluser''' |
+ | |} | ||
+ | |||
+ | '''POST-DATA:''' | ||
+ | |||
+ | {| class="wikitable" width="65%" | ||
+ | ! align="center" colspan="2" | Parâmetros enviados para o medidor via JSON | ||
+ | |- | ||
+ | | align="left"| id || ID do usuário. Valor inteiro de 0 a 65535. | ||
+ | |- | ||
+ | | align="left"| user || login do usuário. Tamanho máximo 20 caracteres. | ||
+ | |- | ||
+ | | align="left"| key || '''Chave Primária do Integrador''', configurada/adicionada na inclusão do usuário (campo disponível somente via API). Tamanho máximo 16 caracteres. | ||
+ | |} | ||
+ | |||
+ | |||
+ | <BR> | ||
+ | {| style="width: 100%; background-color: orange;" | ||
+ | | Ao enviar o comando '''deluser''' com o parâmetro '''key''', todos usuários com a mesma '''chave primária''' ('''key''') serão removidos. | ||
|} | |} | ||
== Exemplo == | == Exemplo == | ||
+ | |||
+ | '''Removendo pelo usuário:''' | ||
+ | {| class="wikitable" | ||
+ | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=deluser HTTP/1.1 | ||
+ | Host: 10.0.0.1:8080 | ||
+ | Accept: */* | ||
+ | Content-Type: application/json | ||
+ | Content-Length: 167 | ||
+ | |||
+ | {"user":"1005"} | ||
+ | </pre> | ||
+ | |} | ||
+ | '''Ou removendo '''TODOS''' usuários com a mesma chave primária. | ||
{| class="wikitable" | {| class="wikitable" | ||
− | ! style="text-align: left; font-weight: bold;" | <pre> | + | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=deluser HTTP/1.1 |
+ | Host: 10.0.0.1:8080 | ||
+ | Accept: */* | ||
+ | Content-Type: application/json | ||
+ | Content-Length: 167 | ||
+ | |||
+ | {"key":"2eed56b6asea453fe7"} | ||
+ | </pre> | ||
|} | |} | ||
Linha 36: | Linha 78: | ||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
− | + | ||
$user = "utech"; | $user = "utech"; | ||
$pass = "1234"; | $pass = "1234"; | ||
Linha 42: | Linha 84: | ||
$ipaddr = "10.0.0.1"; | $ipaddr = "10.0.0.1"; | ||
− | $ | + | $data = array("user" => "1005"); |
− | $url = "$ipaddr:$port?request= | + | |
+ | $data_string = json_encode($data); | ||
+ | $url = "$ipaddr:$port?request=deluser"; | ||
$ch = curl_init($url); | $ch = curl_init($url); | ||
− | |||
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); | curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); | ||
curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); | curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); | ||
+ | curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); | ||
+ | curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); | ||
+ | curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); | ||
+ | curl_setopt($ch, CURLOPT_HTTPHEADER, array( | ||
+ | 'Content-Type: application/json', | ||
+ | 'Content-Length: ' . strlen($data_string)) | ||
+ | ); | ||
+ | |||
$result = curl_exec($ch); | $result = curl_exec($ch); | ||
if(!$result) { | if(!$result) { | ||
Linha 53: | Linha 104: | ||
return 2; | return 2; | ||
} | } | ||
− | + | ||
− | + | ||
$fs = preg_replace("/<html><body>/", "", "$result"); | $fs = preg_replace("/<html><body>/", "", "$result"); | ||
$rc = preg_replace("/<\/body><\/html>/", "", "$fs"); | $rc = preg_replace("/<\/body><\/html>/", "", "$fs"); | ||
− | echo "Return | + | switch($rc) { |
+ | |||
+ | case "401": | ||
+ | echo "401 => Parametros Invalidos\n"; | ||
+ | break; | ||
+ | |||
+ | case "500": | ||
+ | echo "500 => Falha no comando\n"; | ||
+ | break; | ||
+ | |||
+ | case "200": | ||
+ | echo "200 => OK\n"; | ||
+ | break; | ||
+ | |||
+ | default: | ||
+ | echo "Return Code: $rc\n"; | ||
+ | } | ||
?> | ?> |
Edição atual tal como 20h45min de 7 de janeiro de 2021
Tabela de conteúdo |
O comando Remover usuário é utilizado remover um usuário no controle de acesso do medidor. Como parâmetro de remoção, pode ser utilizado um dos parâmetros listados abaixo).
|
[editar] Comando
MÉTODO: POST
Parâmetros enviados para o medidor | |
---|---|
request | deluser |
POST-DATA:
Parâmetros enviados para o medidor via JSON | |
---|---|
id | ID do usuário. Valor inteiro de 0 a 65535. |
user | login do usuário. Tamanho máximo 20 caracteres. |
key | Chave Primária do Integrador, configurada/adicionada na inclusão do usuário (campo disponível somente via API). Tamanho máximo 16 caracteres. |
Ao enviar o comando deluser com o parâmetro key, todos usuários com a mesma chave primária (key) serão removidos. |
[editar] Exemplo
Removendo pelo usuário:
POST /?request=deluser HTTP/1.1 Host: 10.0.0.1:8080 Accept: */* Content-Type: application/json Content-Length: 167 {"user":"1005"} |
---|
Ou removendo TODOS usuários com a mesma chave primária.
POST /?request=deluser HTTP/1.1 Host: 10.0.0.1:8080 Accept: */* Content-Type: application/json Content-Length: 167 {"key":"2eed56b6asea453fe7"} |
---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 500 => Falha no comando
- 200 => OK
[editar] PHP
<?php $user = "utech"; $pass = "1234"; $port = "8080"; $ipaddr = "10.0.0.1"; $data = array("user" => "1005"); $data_string = json_encode($data); $url = "$ipaddr:$port?request=deluser"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'Content-Type: application/json', 'Content-Length: ' . strlen($data_string)) ); $result = curl_exec($ch); if(!$result) { echo "error!\n"; return 2; } $fs = preg_replace("/<html><body>/", "", "$result"); $rc = preg_replace("/<\/body><\/html>/", "", "$fs"); switch($rc) { case "401": echo "401 => Parametros Invalidos\n"; break; case "500": echo "500 => Falha no comando\n"; break; case "200": echo "200 => OK\n"; break; default: echo "Return Code: $rc\n"; } ?> |