MPI/API/CmdAdicionarFingerprint
De uTech Tecnologia
(Diferença entre revisões)
(Criou página com ' __TOC__ O comando '''Adicionar usuário''' é utilizado inserir um usuário no controle de acesso do porteiro == Comando == <BR\> '''MÉTODO:''' <span style="color:red">''...') |
(→Comando) |
||
| (19 edições intermediárias de um usuário não apresentadas) | |||
| Linha 2: | Linha 2: | ||
__TOC__ | __TOC__ | ||
| − | O comando ''' | + | O comando '''Cadastrar Biometria''' é utilizado para ler e cadastrar a biometria de uma um usuário no controle de acesso do porteiro |
== Comando == | == Comando == | ||
| Linha 9: | Linha 9: | ||
'''MÉTODO:''' <span style="color:red">'''POST'''</span> | '''MÉTODO:''' <span style="color:red">'''POST'''</span> | ||
| − | {| class="wikitable" width=" | + | {| class="wikitable" width="75%" |
! align="center" colspan="2" | Parâmetros enviados para o Porteiro | ! align="center" colspan="2" | Parâmetros enviados para o Porteiro | ||
|- | |- | ||
| − | | align="left"| '''request''' || ''' | + | | align="left"| '''request''' || '''finger''' |
| + | |- | ||
| + | | align="left"| '''state''' || | ||
| + | * '''On''': Indica para o porteiro iniciar o processo de leitura da biometria. | ||
| + | * '''Off''': Indica para o porteiro parar/cancelar o processo de leitura da biometria (Enviar valor 'off' caso deseja cancelar a processo cadastro da biomnetria) | ||
|} | |} | ||
'''POST-DATA:''' | '''POST-DATA:''' | ||
| − | {| class="wikitable" width=" | + | |
| + | {| style="width: 100%; background-color: orange;" | ||
| + | | '''NOTA''': Pelo menos, um dos parâmetros '''user''' ou '''id''' '''DEVE''' ser enviado no comando para que a nova biometria lida, seja associada a um usuário já cadastrado.<BR> | ||
| + | |} | ||
| + | |||
| + | {| class="wikitable" width="75%" | ||
! align="center" colspan="2" | Parâmetros enviados para o Porteiro via JSON | ! align="center" colspan="2" | Parâmetros enviados para o Porteiro via JSON | ||
|- | |- | ||
| − | | align="left"| | + | | align="left"| user || Login do usuário, '''previamente configurado''' no comando [[MPI/API/CmdAdicionarUsuario|'''CmdAdicionarUsuario''']]. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| card || Cartão NFC/Mifire do usuário, '''previamente configurado'' no comando [[MPI/API/CmdAdicionarUsuario|'''CmdAdicionarUsuario''']]. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| qrcode || QR Code do usuário, '''previamente configurado'' no comando [[MPI/API/CmdAdicionarUsuario|'''CmdAdicionarUsuario''']]. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| frcode || Código RF do usuário, '''previamente configurado'' no comando [[MPI/API/CmdAdicionarUsuario|'''CmdAdicionarUsuario''']]. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| id || id do usuário, '''listado nos comandos''' [[MPI/API/CmdCheckUser|'''CmdCheckUser''']], [[MPI/API/CmdListarUsuarios|'''CmdListarUsuarios''']] ou [[MPI/API/CmdGetUser|'''CmdGetUser''']]. |
|- | |- | ||
| − | | align="left"| | + | | align="left"| panic || Define se o dedo cadastrado será para pânico ou não. Campo opcional. Padrão '''false'''. |
| + | * '''false''': Dedo cadastrado sem panico. | ||
| + | * '''true''': Dedo cadastrado como panico. | ||
|- | |- | ||
| − | | align="left"| | + | | align="left"| finger || Identificação do dedo utilizado na biometria. Este campo '''DEVE''' ser utilizado com um dos campos de identificação acima. '''Este campo é opcional'''.<BR> |
| − | + | É utilizado uma letra para identificação do dedo: | |
| − | + | * '''0''': Dedo não definido. | |
| − | + | * '''A''': Dedo polegar direito. | |
| − | + | * '''B''': Dedo indicador direito. | |
| − | + | * '''C''': Dedo médio direito. | |
| − | + | * '''D''': Dedo anelar direito. | |
| − | + | * '''E''': Dedo mínimo direito. | |
| − | + | * '''F''': Dedo polegar esquerdo. | |
| − | + | * '''G''': Dedo indicador esquerdo. | |
| − | + | * '''H''': Dedo médio esquerdo. | |
| − | + | * '''I''': Dedo anelar esquerdo. | |
| − | + | * '''J''': Dedo mínimo esquerdo. | |
| − | | | + | |} |
| − | + | ||
| − | + | ||
| − | | | + | {| style="width: 100%; background-color: orange;" |
| − | + | | '''NOTA''': Pelo menos, um dos parâmetros '''user''', '''card''', '''qrcode''', '''rfcode''' ou '''id''' '''DEVE''' ser enviado no comando para que a nova biometria lida, seja associada a um usuário já cadastrado.<BR> | |
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
| + | <BR><BR> | ||
== Exemplo == | == Exemplo == | ||
| − | + | '''Passando comando com parâmetro '''user''' | |
{| class="wikitable" | {| class="wikitable" | ||
| − | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request= | + | ! style="text-align: left; font-weight: bold;" | <pre>POST /?request=finger&state=on HTTP/1.1 |
Content-Type: application/json | Content-Type: application/json | ||
Content-Length: 167 | Content-Length: 167 | ||
| − | { | + | { |
"user":"1005", | "user":"1005", | ||
| − | " | + | "finger": "A" |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
} | } | ||
</pre> | </pre> | ||
|} | |} | ||
| + | |||
| + | |||
'''Resposta:''' | '''Resposta:''' | ||
| Linha 81: | Linha 85: | ||
* '''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 | * '''500''' => Falha no comando | ||
* '''200''' => OK | * '''200''' => OK | ||
| Linha 98: | Linha 103: | ||
$ipaddr = "10.0.0.1"; | $ipaddr = "10.0.0.1"; | ||
| − | $data array( | + | $data = array( |
| − | + | "user" => "1005" | |
| − | "user" => "1005 | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
); | ); | ||
$data_string = json_encode($data); | $data_string = json_encode($data); | ||
| − | $url = "$ipaddr:$port?request= | + | $url = "$ipaddr:$port?request=finger&state=on"; |
$ch = curl_init($url); | $ch = curl_init($url); | ||
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); | curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); | ||
| Linha 134: | Linha 134: | ||
echo "400 => Parametros Invalidos\n"; | echo "400 => Parametros Invalidos\n"; | ||
break; | break; | ||
| − | + | ||
case "401": | case "401": | ||
echo "401 => Erro de autenticação da API\n"; | echo "401 => Erro de autenticação da API\n"; | ||
| + | break; | ||
| + | |||
| + | case "404": | ||
| + | echo "404 => Usuário não encontrado\n"; | ||
break; | break; | ||
Edição atual tal como 12h48min de 11 de junho de 2024
Tabela de conteúdo |
O comando Cadastrar Biometria é utilizado para ler e cadastrar a biometria de uma um usuário no controle de acesso do porteiro
[editar] Comando
MÉTODO: POST
| Parâmetros enviados para o Porteiro | |
|---|---|
| request | finger |
| state |
|
POST-DATA:
| NOTA: Pelo menos, um dos parâmetros user ou id DEVE ser enviado no comando para que a nova biometria lida, seja associada a um usuário já cadastrado. |
| Parâmetros enviados para o Porteiro via JSON | |
|---|---|
| user | Login do usuário, previamente configurado no comando CmdAdicionarUsuario. |
| card | Cartão NFC/Mifire do usuário, 'previamente configurado no comando CmdAdicionarUsuario. |
| qrcode | QR Code do usuário, 'previamente configurado no comando CmdAdicionarUsuario. |
| frcode | Código RF do usuário, 'previamente configurado no comando CmdAdicionarUsuario. |
| id | id do usuário, listado nos comandos CmdCheckUser, CmdListarUsuarios ou CmdGetUser. |
| panic | Define se o dedo cadastrado será para pânico ou não. Campo opcional. Padrão false.
|
| finger | Identificação do dedo utilizado na biometria. Este campo DEVE ser utilizado com um dos campos de identificação acima. Este campo é opcional. É utilizado uma letra para identificação do dedo:
|
| NOTA: Pelo menos, um dos parâmetros user, card, qrcode, rfcode ou id DEVE ser enviado no comando para que a nova biometria lida, seja associada a um usuário já cadastrado. |
[editar] Exemplo
Passando comando com parâmetro user
POST /?request=finger&state=on HTTP/1.1
Content-Type: application/json
Content-Length: 167
{
"user":"1005",
"finger": "A"
}
|
|---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 404 => Usuário não encontrado
- 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=finger&state=on"; $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 "400": echo "400 => Parametros Invalidos\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"; } ?> |
