MLI/API/CmdRemoverUsuario
De uTech Tecnologia
(Diferença entre revisões)
(→Exemplo) |
|||
(9 edições intermediárias de um usuário não apresentadas) | |||
Linha 2: | Linha 2: | ||
__TOC__ | __TOC__ | ||
− | O comando '''Remover usuário''' é utilizado remover um usuário no controle de acesso do leitor. Como parâmetro de remoção, pode ser utilizado um dos parâmetros listados abaixo | + | O comando '''Remover usuário''' é utilizado remover um usuário no controle de acesso do leitor. 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 leitor'''. | ||
+ | * '''No caso configuração biométrica cadastrada, este comando irá demorar pelo menos 500ms'''. | ||
+ | |} | ||
== Comando == | == Comando == | ||
Linha 17: | Linha 21: | ||
'''POST-DATA:''' | '''POST-DATA:''' | ||
− | {| class="wikitable" width=" | + | {| class="wikitable" width="85%" |
! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON | ! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON | ||
|- | |- | ||
− | | align="left"| id || ID do usuário. | + | | align="left"| id || ID do usuário. Valor inteiro de 0 a 65535. |
|- | |- | ||
− | | align="left"| user || login do usuário. | + | | align="left"| user || login do usuário. Tamanho máximo 20 caracteres. |
|- | |- | ||
− | | align="left"| card || Identificação de acesso via cartão '''MIFARE / NFC''' | + | | align="left"| <del>card</del> || <del>Identificação de acesso via cartão '''MIFARE / NFC'''. Tamanho máximo 32 caracteres'</del>. <span style="color:#ff0000">Removido na versão 1.1.30</span> |
|- | |- | ||
− | | align="left"| qrcode || Identificação de acesso via '''QR Code''' | + | | align="left"| <del>qrcode</del> || <del>Identificação de acesso via '''QR Code'''. Tamanho máximo 128 caracteres</del>. <span style="color:#ff0000">Removido na versão 1.1.30</span> |
|- | |- | ||
− | | align="left"| rfcode || Identificação de acesso via '''RF 433''' (Controle) | + | | align="left"| <del>rfcode</del> || <del>Identificação de acesso via '''RF 433''' (Controle). Tamanho máximo 16 caracteres</del>. <span style="color:#ff0000">Removido na versão 1.1.30</span> |
|- | |- | ||
− | | align="left"| key || '''Chave Primária do Integrador''', configurada/adicionada na inclusão do usuário (campo disponível somente via API). | + | | align="left"| <del>fingerprint</del> || <del>Identificação de acesso via biometria. O tamanho e os dados '''DEVEM''' ser idênticos ao profile gerado pelo equipamento</del>. <span style="color:#ff0000">Removido na versão 1.1.30</span> |
+ | |- | ||
+ | | 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. | ||
|} | |} | ||
Linha 36: | Linha 42: | ||
<BR> | <BR> | ||
{| style="width: 100%; background-color: orange;" | {| style="width: 100%; background-color: orange;" | ||
− | | Ao enviar o comando '''deluser''' com o parâmetro '''key''', todos | + | | Ao enviar o comando '''deluser''' com o parâmetro '''key''', todos usuários com a mesma '''chave primária''' ('''key''') serão removidos. |
|} | |} | ||
Linha 53: | Linha 59: | ||
|} | |} | ||
− | '''Ou removendo pelo | + | '''Ou removendo pelo id:''' |
+ | |||
{| class="wikitable" | {| class="wikitable" | ||
! style="text-align: left; font-weight: bold;" | <pre>POST /?request=deluser HTTP/1.1 | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=deluser HTTP/1.1 | ||
Linha 61: | Linha 68: | ||
Content-Length: 167 | Content-Length: 167 | ||
− | {" | + | {"id":"1"} |
</pre> | </pre> | ||
|} | |} |
Edição atual tal como 17h54min de 10 de outubro de 2024
Tabela de conteúdo |
O comando Remover usuário é utilizado remover um usuário no controle de acesso do leitor. 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 Leitor | |
---|---|
request | deluser |
POST-DATA:
Parâmetros enviados para o Leitor 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 pelo id:
POST /?request=deluser HTTP/1.1 Host: 10.0.0.1:8080 Accept: */* Content-Type: application/json Content-Length: 167 {"id":"1"} |
---|
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"; } ?> |