MLW/API/CmdGetUser

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(Criou página com ' __TOC__ 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 lis...')
 
(Exemplo)
 
(3 edições intermediárias de um usuário não apresentadas)
Linha 24: Linha 24:
 
| align="left"| user || login do usuário.
 
| align="left"| user || login do usuário.
 
|-
 
|-
| 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</del>. <span style="color:#ff0000">Removido na versão 1.1.10</span>
 
|-
 
|-
| align="left"| rfcode || Identificação de acesso via '''RF 433''' (Controle)
+
| align="left"| <del>rfcode</del> || <del>vIdentificação de acesso via '''RF 433''' (Controle)</del>. <span style="color:#ff0000">Removido na versão 1.1.10</span>
 
|}
 
|}
  
Linha 43: Linha 43:
 
|}
 
|}
  
'''Ou buscando pelo número do cartão:'''
+
'''Ou buscando pelo id:'''
 
{| class="wikitable"
 
{| class="wikitable"
 
! style="text-align: left; font-weight: bold;" | <pre>POST /?request=getuser HTTP/1.1
 
! style="text-align: left; font-weight: bold;" | <pre>POST /?request=getuser HTTP/1.1
Linha 51: Linha 51:
 
Content-Length: 167
 
Content-Length: 167
  
{"card":"1234567890"}
+
{"id":"1"}
</pre>
+
|}
+
 
+
 
+
'''Resposta:'''
+
 
+
* '''400''' => Parâmetros incorretos
+
* '''401''' => Erro de autenticação da API
+
* '''404''' => Usuário não encontrado
+
* '''500''' => Falha no comando
+
* '''200''' => OK
+
 
+
{| class="wikitable"
+
! style="text-align: left; font-weight: bold;" |
+
<source lang="php">
+
Content-Type: application/json
+
 
+
{
+
        "id": "1",
+
        "name":"Rivarola Catalino Mendes",
+
        "user":"1000",
+
        "password":"1234",
+
        "card":"",
+
        "qrcode":"83009a8d0ecb6a88cab42a1d4c3ed47d",
+
        "rfcode":"",
+
        "validity:":"0",
+
        "lifecount":"0",
+
        "accessibility":"false",
+
        "panic":"false",
+
        "key":"rcd345fddea"
+
}
+
</source>
+
|}
+
 
+
 
+
<br/><br/>
+
 
+
== PHP ==
+
{| class="wikitable" width="65%"
+
|
+
<source lang="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;
+
 
+
__TOC__
+
 
+
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 (user, card, rfcode, fingerprint ou qrcode).
+
 
+
== Comando ==
+
 
+
<BR\>
+
'''MÉTODO:''' <span style="color:red">'''POST'''</span>
+
 
+
{| class="wikitable" width="65%"
+
! align="center" colspan="2" | Parâmetros enviados para o Leitor
+
|-
+
| align="left"| '''request''' || '''getuser'''
+
|}
+
 
+
'''POST-DATA:'''
+
 
+
{| class="wikitable" width="65%"
+
! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON
+
|-
+
| align="left"| id || ID do usuário.
+
|-
+
| align="left"| user || login do usuário.
+
|-
+
| align="left"| card || Identificação de acesso via cartão '''MIFARE / NFC'''
+
|-
+
| 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'''
+
|}
+
 
+
== 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"
+
! 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>
 
</pre>
 
|}
 
|}
Linha 236: Linha 88:
  
  
<br/><br/>
+
{| style="width: 100%; background-color: #E7E3EB;"  
 
+
== PHP ==
+
{| class="wikitable" width="65%"
+
 
|
 
|
<source lang="php">
+
* Ver descrição dos campo no comando [[MLW/API/CmdListarUsuarios|'''Listar Usuários''']]
<?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";
+
}
+
 
+
?>
+
</source>
+
 
|}
 
|}
 
__TOC__
 
 
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 (user, card, rfcode, fingerprint ou qrcode).
 
 
== Comando ==
 
 
<BR\>
 
'''MÉTODO:''' <span style="color:red">'''POST'''</span>
 
 
{| class="wikitable" width="65%"
 
! align="center" colspan="2" | Parâmetros enviados para o Leitor
 
|-
 
| align="left"| '''request''' || '''getuser'''
 
|}
 
 
'''POST-DATA:'''
 
 
{| class="wikitable" width="65%"
 
! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON
 
|-
 
| align="left"| id || ID do usuário.
 
|-
 
| align="left"| user || login do usuário.
 
|-
 
| align="left"| card || Identificação de acesso via cartão '''MIFARE / NFC'''
 
|-
 
| 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'''
 
|}
 
 
== 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"
 
! 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:'''
 
 
* '''400''' => Parâmetros incorretos
 
* '''401''' => Erro de autenticação da API
 
* '''404''' => Usuário não encontrado
 
* '''500''' => Falha no comando
 
* '''200''' => OK
 
 
{| class="wikitable"
 
! style="text-align: left; font-weight: bold;" |
 
<source lang="php">
 
Content-Type: application/json
 
 
{
 
        "id": "1",
 
        "name":"Rivarola Catalino Mendes",
 
        "user":"1000",
 
        "password":"1234",
 
        "card":"",
 
        "qrcode":"83009a8d0ecb6a88cab42a1d4c3ed47d",
 
        "rfcode":"",
 
        "fingerprint":"",
 
        "validity:":"0",
 
        "lifecount":"0",
 
        "accessibility":"false",
 
        "panic":"false",
 
        "key":"rcd345fddea"
 
}
 
</source>
 
|}
 
 
  
 
<br/><br/>
 
<br/><br/>
Linha 477: Linha 169:
 
<br/>
 
<br/>
 
<br/>
 
<br/>
[[MLI/API#Comandos|'''Voltar''']]
+
[[MLW/API#Comandos|'''Voltar''']]
-----
+
 
+
<br/>
+
<br/>
+
<br/>
+
[[MLI/API#Comandos|'''Voltar''']]
+
-----
+
 
+
    case "500":
+
        echo "500 => Falha no comando\n";
+
    break;
+
 
+
    case "200":
+
        echo "200 => OK\n";
+
    break;
+
 
+
    default:
+
        echo "Return Code: $rc\n";
+
}
+
 
+
?>
+
</source>
+
|}
+
 
+
<br/>
+
<br/>
+
<br/>
+
[[MLI/API#Comandos|'''Voltar''']]
+
 
-----
 
-----

Edição atual tal como 18h40min de 10 de outubro de 2024

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 (user, card, rfcode, fingerprint ou qrcode).

[editar] 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. Removido na versão 1.1.10
rfcode vIdentificação de acesso via RF 433 (Controle). Removido na versão 1.1.10

[editar] 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 id:

POST /?request=getuser HTTP/1.1
Host: 10.0.0.1:8080
Accept: */*
Content-Type: application/json
Content-Length: 167

{"id":"1"}


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": "1",
        "name":"Rivarola Catalino Mendes",
        "user":"1000",
        "password":"1234",
        "card":"",
        "qrcode":"83009a8d0ecb6a88cab42a1d4c3ed47d",
        "rfcode":"",
        "fingerprint":"",
        "validity:":"0",
        "lifecount":"0",
        "accessibility":"false",
        "panic":"false",
        "key":"rcd345fddea"
}




[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=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";
}
 
?>




Voltar


Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas