MLW/API/CmdListarUsuarios
De uTech Tecnologia
(Diferença entre revisões)
(→Comando) |
|||
| Linha 2: | Linha 2: | ||
__TOC__ | __TOC__ | ||
| − | O comando ''' | + | O comando '''Buscar Usuário''' é utilizado soliciar a configuração de um usuário cadastrado. Como parâmetro de busca, pode ser utilizado um dos parâmetros listados abaixo (id, user, card ou rfcode). |
== 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 Leitor | ! align="center" colspan="2" | Parâmetros enviados para o Leitor | ||
|- | |- | ||
| − | | align="left"| request || ''' | + | | align="left"| '''request''' || '''getuser''' |
|} | |} | ||
| + | |||
| + | '''POST-DATA:''' | ||
{| class="wikitable" width="65%" | {| class="wikitable" width="65%" | ||
| − | ! align="center" colspan="2" | | + | ! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
| − | | align="left"| | + | | align="left"| id || ID do usuário. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| user || login do usuário. |
|- | |- | ||
| align="left"| card || Identificação de acesso via cartão '''MIFARE / NFC''' | | align="left"| card || Identificação de acesso via cartão '''MIFARE / NFC''' | ||
|- | |- | ||
| − | | align="left"| rfcode || Identificação de acesso via ''' | + | | align="left"| rfcode || Identificação de acesso via '''RF 433''' (Controle) |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
== Exemplo == | == Exemplo == | ||
| + | '''Buscando pelo usuário:''' | ||
| + | {| class="wikitable" | ||
| + | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=getuser HTTP/1.1 | ||
| + | Host: 10.0.0.1:8080 | ||
| + | Accept: */* | ||
| + | Content-Type: application/json | ||
| + | Content-Length: 167 | ||
| + | {"user":"1005"} | ||
| + | </pre> | ||
| + | |} | ||
| + | |||
| + | '''Ou buscando pelo número do cartão:''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | ! style="text-align: left; font-weight: bold;" | <pre> | + | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=getuser HTTP/1.1 |
| + | Host: 10.0.0.1:8080 | ||
| + | Accept: */* | ||
| + | Content-Type: application/json | ||
| + | Content-Length: 167 | ||
| + | |||
| + | {"card":"1234567890"} | ||
| + | </pre> | ||
|} | |} | ||
| + | |||
'''Resposta:''' | '''Resposta:''' | ||
| Linha 78: | Linha 60: | ||
* '''400''' => Parâmetros incorretos | * '''400''' => Parâmetros incorretos | ||
* '''401''' => Erro de autenticação da API | * '''401''' => Erro de autenticação da API | ||
| + | * '''404''' => Usuário não encontrado | ||
| + | * '''500''' => Falha no comando | ||
* '''200''' => OK | * '''200''' => OK | ||
| Linha 85: | Linha 69: | ||
Content-Type: application/json | Content-Type: application/json | ||
| − | + | { | |
| − | + | "id":"0", | |
| − | + | "name":"Marcos", | |
| − | + | "user":"1005", | |
| − | + | "password":"1234", | |
| − | + | "card":"00000123456", | |
| − | + | "rfcode":"1234567890", | |
| − | + | "fingerprint":"", | |
| − | + | "lifecount":"0", | |
| − | + | "accessibility":"false", | |
| − | + | "panic":"false", | |
| − | + | "key":"", | |
| − | + | "administrator":"false", | |
| − | + | "visitor":"false", | |
| − | + | "finger":"", | |
| − | + | "relay":"0", | |
| − | + | "interface":"b", | |
| − | + | "perm1":"", | |
| − | + | "perm2":"", | |
| − | + | "perm3":"", | |
| − | + | "perm4":"", | |
| − | + | "perm5":"" | |
| − | + | } | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</source> | </source> | ||
|} | |} | ||
| + | |||
| + | * [[MLW/API/CmdListarUsuarios|'''Ver descrição dos campo em Listar Usuários''']] | ||
<br/><br/> | <br/><br/> | ||
| Linha 137: | Linha 104: | ||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
| − | + | ||
$user = "utech"; | $user = "utech"; | ||
$pass = "1234"; | $pass = "1234"; | ||
| Linha 143: | Linha 110: | ||
$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=getuser"; | ||
$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 154: | Linha 130: | ||
return 2; | return 2; | ||
} | } | ||
| − | + | ||
| + | $fs = preg_replace("/<html><body>/", "", "$result"); | ||
| + | $rc = preg_replace("/<\/body><\/html>/", "", "$fs"); | ||
| + | |||
| + | switch($rc) { | ||
| + | |||
| + | /* '''400''' => Parâmetros incorretos */ | ||
| + | /* '''401''' => Erro de autenticação da API */ | ||
| + | /* '''404''' => Usuário não encontrado */ | ||
| + | /* '''500''' => Falha no comando */ | ||
| + | /* '''200''' => OK */ | ||
| + | |||
| + | case "400": | ||
| + | echo "400 => Parâmetros Inválidos\n"; | ||
| + | break; | ||
| + | |||
| + | case "401": | ||
| + | echo "401 => Erro de autenticação da API\n"; | ||
| + | break; | ||
| + | |||
| + | case "404": | ||
| + | echo "404 => Usuário não encontrado\n"; | ||
| + | break; | ||
| + | |||
| + | case "500": | ||
| + | echo "500 => Falha no comando\n"; | ||
| + | break; | ||
| + | |||
| + | case "200": | ||
| + | echo "200 => OK\n"; | ||
| + | break; | ||
| + | |||
| + | default: | ||
| + | echo "Return Code: $rc\n"; | ||
| + | } | ||
| + | |||
?> | ?> | ||
</source> | </source> | ||
| Linha 162: | Linha 173: | ||
<br/> | <br/> | ||
<br/> | <br/> | ||
| − | [[ | + | [[MLW/API#Comandos|'''Voltar''']] |
----- | ----- | ||
Edição de 17h12min de 22 de junho de 2022
Tabela de conteúdo |
O comando Buscar Usuário é utilizado soliciar a configuração de um usuário cadastrado. Como parâmetro de busca, pode ser utilizado um dos parâmetros listados abaixo (id, user, card ou rfcode).
Comando
MÉTODO: POST
| Parâmetros enviados para o Leitor | |
|---|---|
| request | getuser |
POST-DATA:
| Parâmetros enviados para o Leitor via JSON | |
|---|---|
| id | ID do usuário. |
| user | login do usuário. |
| card | Identificação de acesso via cartão MIFARE / NFC |
| rfcode | Identificação de acesso via RF 433 (Controle) |
Exemplo
Buscando pelo usuário:
POST /?request=getuser HTTP/1.1
Host: 10.0.0.1:8080
Accept: */*
Content-Type: application/json
Content-Length: 167
{"user":"1005"}
|
|---|
Ou buscando pelo número do cartão:
POST /?request=getuser HTTP/1.1
Host: 10.0.0.1:8080
Accept: */*
Content-Type: application/json
Content-Length: 167
{"card":"1234567890"}
|
|---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 404 => Usuário não encontrado
- 500 => Falha no comando
- 200 => OK
Content-Type: application/json { "id":"0", "name":"Marcos", "user":"1005", "password":"1234", "card":"00000123456", "rfcode":"1234567890", "fingerprint":"", "lifecount":"0", "accessibility":"false", "panic":"false", "key":"", "administrator":"false", "visitor":"false", "finger":"", "relay":"0", "interface":"b", "perm1":"", "perm2":"", "perm3":"", "perm4":"", "perm5":"" } |
|---|
- Ver descrição dos campo em Listar Usuários
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=getuser"; $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) { /* '''400''' => Parâmetros incorretos */ /* '''401''' => Erro de autenticação da API */ /* '''404''' => Usuário não encontrado */ /* '''500''' => Falha no comando */ /* '''200''' => OK */ case "400": echo "400 => Parâmetros Inválidos\n"; break; case "401": echo "401 => Erro de autenticação da API\n"; break; case "404": echo "404 => Usuário não encontrado\n"; break; case "500": echo "500 => Falha no comando\n"; break; case "200": echo "200 => OK\n"; break; default: echo "Return Code: $rc\n"; } ?> |
