MPI/API/CmdRemoverUsuario
De uTech Tecnologia
(Diferença entre revisões)
(→PHP) |
(→Comando) |
||
(18 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 porteiro. Como parâmetro de remoção, pode ser utilizado um dos | + | O comando '''Remover usuário''' é utilizado remover um usuário no controle de acesso do porteiro. Como parâmetro de remoção, pode ser utilizado um dos parâmetros listados abaixo. |
== Comando == | == Comando == | ||
+ | {| style="width: 100%; background-color: orange;" | ||
+ | | '''NOTA:''' É mandatório utilizar o parâmetro '''user''' ou o parâmetro '''id''' (se não utilizar o parâmetro key) | ||
+ | |} | ||
<BR\> | <BR\> | ||
'''MÉTODO:''' <span style="color:red">'''POST'''</span> | '''MÉTODO:''' <span style="color:red">'''POST'''</span> | ||
Linha 18: | Linha 21: | ||
{| class="wikitable" width="65%" | {| class="wikitable" width="65%" | ||
− | ! align="center" colspan="2" | Parâmetros enviados para o | + | ! align="center" colspan="2" | Parâmetros enviados para o porteiro via JSON |
+ | |- | ||
+ | | align="left"| id || ID do usuário. | ||
|- | |- | ||
| align="left"| user || login do usuário. | | align="left"| user || login do usuário. | ||
Linha 25: | Linha 30: | ||
|- | |- | ||
| align="left"| qrcode || Identificação de acesso via '''QR Code''' | | align="left"| qrcode || Identificação de acesso via '''QR Code''' | ||
+ | |- | ||
+ | | align="left"| rfcode || Identificação de acesso via '''RF 433''' (Controle) | ||
+ | |- | ||
+ | | align="left"| fingerprint || Identificação de acesso via biometria | ||
+ | |- | ||
+ | | align="left"| key || '''Chave Primária do Integrador''', configurada/adicionada na inclusão do usuário (campo disponível somente via API). | ||
|} | |} | ||
− | |||
+ | <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 == | ||
+ | |||
+ | '''Removendo pelo usuário:''' | ||
{| class="wikitable" | {| class="wikitable" | ||
− | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request= | + | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=deluser HTTP/1.1 |
Host: 10.0.0.1:8080 | Host: 10.0.0.1:8080 | ||
Accept: */* | Accept: */* | ||
Linha 38: | Linha 55: | ||
{"user":"1005"} | {"user":"1005"} | ||
+ | </pre> | ||
+ | |} | ||
+ | |||
+ | '''Ou removendo pelo número do cartão:''' | ||
+ | {| 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 | ||
+ | |||
+ | {"id": "1"} | ||
+ | </pre> | ||
+ | |} | ||
+ | |||
+ | '''Ou removendo TODOS usuários com a mesma chave primária. | ||
+ | {| 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 | ||
+ | |||
+ | {"key":"2eed56b6asea453fe7"} | ||
</pre> | </pre> | ||
|} | |} |
Edição atual tal como 12h45min de 11 de junho de 2024
Tabela de conteúdo |
O comando Remover usuário é utilizado remover um usuário no controle de acesso do porteiro. Como parâmetro de remoção, pode ser utilizado um dos parâmetros listados abaixo.
[editar] Comando
NOTA: É mandatório utilizar o parâmetro user ou o parâmetro id (se não utilizar o parâmetro key) |
MÉTODO: POST
Parâmetros enviados para o Porteiro | |
---|---|
request | deluser |
POST-DATA:
Parâmetros enviados para o porteiro via JSON | |
---|---|
id | ID do usuário. |
user | login do usuário. |
card | Identificação de acesso via cartão MIFARE / NFC |
qrcode | Identificação de acesso via QR Code |
rfcode | Identificação de acesso via RF 433 (Controle) |
fingerprint | Identificação de acesso via biometria |
key | Chave Primária do Integrador, configurada/adicionada na inclusão do usuário (campo disponível somente via API). |
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 número do cartão:
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"; } ?> |