O comando Lista Usuários utilizado para buscar a lista de usuários cadastrados na catraca.
Comando
MÉTODO: GET
| Parâmetros enviados para a Catraca
|
| request |
users
|
| Resposta enviada pelo a Catraca
|
| 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
|
| fingerprint |
Identificação de acesso via Biometria
|
| validity |
Tempo em segundos para expirar as permissões do usuário (0 - Desabilitado)
|
| perm1 |
Permissão de acesso 1 - Veja mais sobre as permissões no link: MPI/PermissõesDeAcesso
|
| perm2 |
Permissão de acesso 2 - Veja mais sobre as permissões no link: MPI/PermissõesDeAcesso
|
| perm3 |
Permissão de acesso 3 - Veja mais sobre as permissões no link: MPI/PermissõesDeAcesso
|
| perm4 |
Permissão de acesso 4 - Veja mais sobre as permissões no link: MPI/PermissõesDeAcesso
|
| perm5 |
Permissão de acesso 5 - Veja mais sobre as permissões no link: MPI/PermissõesDeAcesso
|
| lifecount |
Define a quantidade de vezes que o usuário terá o acesso liberado na catraca. 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 - Geral.
- true: Habilitado.
- false: Desabilitado.
|
| 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.
- true: Habilitado.
- false: Desabilitado.
|
| key |
Permite cadastrar a chave primária do integrador para manipulação de usuários.
|
| administrator |
Define se o usuário tem permissão de administrador. Usuário com permissão de administrado poderá gerenciar a catraca via API ou aplicativo EasyKey.
- true: Usuário tem permissão de administrador.
- false: Usuário não tem permissão de administrador.
|
| email |
Endereço de e-mail do usuário. Utilizado para envio de notificações. Ver menu Notificações
|
| apn |
Código de integração para push notification para iOS (Apple).
|
| fcm |
Código de integração para push notification para Android (Google).
|
| visitor |
Define se o novo usuário é um visitante.
- true: Usuário é visitante.
- false: Usuário não é visitante.
|
| 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.
|
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":"Paulo Nunes",
"user":"7000",
"password":"1111",
"card":"12345678",
"qrcode":"Catraca IP uTech",
"fingerprint":"",
"validity":"0",
"lifecount":"0",
"accessibility":"false",
"panic":"false",
"key":"",
"administrator":"false",
"email":" ",
"apn":"",
"fcm":"",
"visitor":"false"
} |
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));
?> |
Voltar
