MPI/API/CmdGetUser
De uTech Tecnologia
(Diferença entre revisões)
(→Exemplo) |
(→Comando) |
||
| (6 edições intermediárias de um usuário não apresentadas) | |||
| 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 24: | Linha 27: | ||
| 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 '''MIFARE / NFC'''</del>. <span style="color:#ff0000">Removido na versão 1.1.60</span> |
|- | |- | ||
| − | | align="left"| qrcode || Identificação de acesso via '''QR Code''' | + | | align="left"| <del>qrcode</del> || <del>Identificação de acesso via '''QR Code'''</del>. <span style="color:#ff0000">Removido na versão 1.1.60</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)</del>. <span style="color:#ff0000">Removido na versão 1.1.60</span> |
|- | |- | ||
| − | | align="left"| fingerprint || Identificação de acesso via '''biometria''' | + | | align="left"| <del>fingerprint</del> || <del>Identificação de acesso via '''biometria''' </del>. <span style="color:#ff0000">Removido na versão 1.1.60</span> |
|- | |- | ||
| align="left"| key || Chave primário do usuário (adicionado na inclusão via API) | | align="left"| key || Chave primário do usuário (adicionado na inclusão via API) | ||
| Linha 57: | Linha 60: | ||
Content-Length: 167 | Content-Length: 167 | ||
| − | {"card":" | + | {"id":"1", "card":"1234567"} |
</pre> | </pre> | ||
|} | |} | ||
Edição atual tal como 17h42min 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
| 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. |
| |
|
| |
|
| |
|
| |
|
| key | Chave primário do usuário (adicionado na inclusão via API) |
[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 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
{"id":"1", "card":"1234567"}
|
|---|
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" } |
|---|
[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"; } ?> |
