MPI/API/CmdGetUser
De uTech Tecnologia
(Diferença entre revisões)
(→Comando) |
(→Comando) |
||
Linha 6: | Linha 6: | ||
== Comando == | == Comando == | ||
+ | {| style="width: 100%; background-color: orange;" | ||
+ | | '''NOTA:''' É mandatório utilizar o parâmetro '''user''' ou o parâmetro '''id''' | ||
+ | |} | ||
<BR\> | <BR\> | ||
'''MÉTODO:''' <span style="color:red">'''POST'''</span> | '''MÉTODO:''' <span style="color:red">'''POST'''</span> | ||
Linha 22: | Linha 25: | ||
| align="left"| id || ID do usuário. | | align="left"| id || ID do usuário. | ||
|- | |- | ||
− | | 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"| card || Identificação de acesso via cartão '''MIFARE / NFC''' |
Edição de 12h44min de 11 de junho 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).
Comando
NOTA: É mandatório utilizar o parâmetro user ou o parâmetro id |
MÉTODO: POST
Parâmetros enviados para o Porteiro | |
---|---|
request | getuser |
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ário do usuário (adicionado na inclusão via API) |
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":"1", "name":"Test 1", "user":"1111", "password":"1234", "card":"1234567890", "qrcode":"#GOuTech", "rfcode":"", "fingerprint":"BBFzAEaSiHuJeskHQXvbOGj...", "validity:":"0", "lifecount":"0", "accessibility":"false", "panic":"false", "key":"", "interface":"00000000", "administrator":"true", "email":" ", "apn":"", "fcm":"", "visitor":"false", "finger":"A" } |
---|
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"; } ?> |