MLI/API/CmdListarUsuarios
De uTech Tecnologia
(Diferença entre revisões)
(Criou página com ' __TOC__ O comando '''Lista Usuários''' utilizado para buscar a lista de usuários cadastrados no leitor. == Comando == '''MÉTODO:''' <span style="color:red">'''GET'''</s...') |
|||
(7 edições intermediárias de um usuário não apresentadas) | |||
Linha 32: | Linha 32: | ||
|- | |- | ||
| align="left"| fingerprint || Identificação de acesso via '''Biometria''' | | align="left"| fingerprint || Identificação de acesso via '''Biometria''' | ||
− | |||
− | |||
|- | |- | ||
| align="left"| perm1 || Permissão de acesso 1 - Veja mais sobre as permissões no link: [[MLI/PermissõesDeAcesso]] | | align="left"| perm1 || Permissão de acesso 1 - Veja mais sobre as permissões no link: [[MLI/PermissõesDeAcesso]] | ||
Linha 57: | Linha 55: | ||
| align="left"| key || Permite cadastrar a '''chave primária''' do integrador para manipulação de usuários. | | align="left"| key || Permite cadastrar a '''chave primária''' do integrador para manipulação de usuários. | ||
|- | |- | ||
− | | align="left"| | + | | align="left"| administrator || Define se o usuário terá permissões de administrados. Usuário administrador poderá utilizar funções de configurações da placa, como inserir novos usuários. |
− | * '' | + | * '''true''': Usuário com permissão de administrador |
− | * ''' | + | * '''false''': Usuário sem permissão de administrador. |
− | * ''' | + | |- |
− | ''' | + | | align="left"| visitor || Identifica se o usuário é visitante ou não. Necessário definir uma data de validade para o visitante em '''Permissões de Acesso''', configurando os campos '''perm1, perm2, perm3, perm4 e perm5'''. |
− | + | * '''true''': É visitante. | |
− | + | * '''false''': Não é visitante. | |
− | + | |- | |
− | + | | align="left"| finger || Identificação do dedo utilizado na biometria. Este campo '''DEVE'''. É 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. | ||
|} | |} | ||
Linha 91: | Linha 96: | ||
[ | [ | ||
− | + | { | |
− | + | "id":"0", | |
− | + | "name":"test 1", | |
− | + | "user":"1111", | |
− | + | "password":"1234", | |
− | + | "card":"", | |
− | + | "qrcode":"#GouTech", | |
− | + | "rfcode":"", | |
− | + | "fingerprint":"BBFmAMVqiIiD...", | |
− | + | "lifecount":"0", | |
− | + | "accessibility":"false", | |
− | + | "panic":"false", | |
− | + | "key":"", | |
− | + | "administrator":"false", | |
− | + | "visitor":"false", | |
− | + | "finger":"A", | |
− | + | "perm1":"", | |
− | + | "perm2":"", | |
− | + | "perm3":"", | |
− | + | "perm4":"", | |
− | + | "perm5":"" | |
− | + | }, | |
− | + | { | |
− | + | "id":"1", | |
− | + | "name":"test 2", | |
− | + | "user":"2222", | |
− | + | "password":"1234", | |
− | + | "card":"", | |
− | + | "qrcode":"#GouTech2", | |
− | + | "rfcode":"", | |
− | + | "fingerprint":"BBFmArFsqiIiD...", | |
− | + | "lifecount":"0", | |
− | + | "accessibility":"false", | |
− | + | "panic":"false", | |
− | + | "key":"", | |
− | + | "administrator":"false", | |
− | + | "visitor":"false", | |
− | + | "finger":"A", | |
− | + | "perm1":"", | |
− | + | "perm2":"", | |
− | + | "perm3":"", | |
− | + | "perm4":"", | |
− | + | "perm5":"" | |
− | + | } | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
] | ] | ||
</source> | </source> |
Edição atual tal como 20h25min de 21 de junho de 2022
Tabela de conteúdo |
O comando Lista Usuários utilizado para buscar a lista de usuários cadastrados no leitor.
[editar] Comando
MÉTODO: GET
Parâmetros enviados para o Leitor | |
---|---|
request | users |
Resposta enviada pelo o Leitor | |
---|---|
id | ID do usuário |
name | Nome do contato cadastrado |
user | Login do usuário cadastrado (somente números). |
password | Senha do usuário cadastrado (somente números). |
card | Identificação de acesso via cartão MIFARE / NFC |
qrcode | Identificação de acesso via QR Code |
rfcode | Identificação de acesso via RF433 - Controle |
fingerprint | Identificação de acesso via Biometria |
perm1 | Permissão de acesso 1 - Veja mais sobre as permissões no link: MLI/PermissõesDeAcesso |
perm2 | Permissão de acesso 2 - Veja mais sobre as permissões no link: MLI/PermissõesDeAcesso |
perm3 | Permissão de acesso 3 - Veja mais sobre as permissões no link: MLI/PermissõesDeAcesso |
perm4 | Permissão de acesso 4 - Veja mais sobre as permissões no link: MLI/PermissõesDeAcesso |
perm5 | Permissão de acesso 5 - Veja mais sobre as permissões no link: MLI/PermissõesDeAcesso |
lifecount | Define a quantidade de vezes que o usuário terá o acesso liberado no leitor. Depois de N vezes, o usuário será automaticamente removido. O Valor zero (0) define como ilimitado. |
accessibility | Define que o usuário criado terá configurações de acessibilidade. Como por exemplo o tempo de acionamento da porta para acessibilidade. Ver docs. menu Controle de Acesso - Interface 1/2.
|
panic | Se habilitado, define que esse usuário é associado a função pânico. Toda vez que sua tag, biometria, QR code, etc..., for detectada, a função pânico será ativada.
|
key | Permite cadastrar a chave primária do integrador para manipulação de usuários. |
administrator | Define se o usuário terá permissões de administrados. Usuário administrador poderá utilizar funções de configurações da placa, como inserir novos usuários.
|
visitor | Identifica se o usuário é visitante ou não. Necessário definir uma data de validade para o visitante em Permissões de Acesso, configurando os campos perm1, perm2, perm3, perm4 e perm5.
|
finger | Identificação do dedo utilizado na biometria. Este campo DEVE. É utilizado uma letra para identificação do dedo:
|
[editar] Exemplo
http://ip:porta/?request=users |
---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 200 => OK
Content-Type: application/json [ { "id":"0", "name":"test 1", "user":"1111", "password":"1234", "card":"", "qrcode":"#GouTech", "rfcode":"", "fingerprint":"BBFmAMVqiIiD...", "lifecount":"0", "accessibility":"false", "panic":"false", "key":"", "administrator":"false", "visitor":"false", "finger":"A", "perm1":"", "perm2":"", "perm3":"", "perm4":"", "perm5":"" }, { "id":"1", "name":"test 2", "user":"2222", "password":"1234", "card":"", "qrcode":"#GouTech2", "rfcode":"", "fingerprint":"BBFmArFsqiIiD...", "lifecount":"0", "accessibility":"false", "panic":"false", "key":"", "administrator":"false", "visitor":"false", "finger":"A", "perm1":"", "perm2":"", "perm3":"", "perm4":"", "perm5":"" } ] |
---|
[editar] PHP
<?php $user = "utech"; $pass = "1234"; $port = "8080"; $ipaddr = "10.0.0.1"; $url = ""; $url = "$ipaddr:$port?request=users"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); $result = curl_exec($ch); if(!$result) { echo "error!\n"; return 2; } print_r(json_decode($result, true)); ?> |