MII/API/CmdListarUsuarios

De uTech Tecnologia
Edição feita às 21h28min de 18 de março de 2024 por Utechnet (disc | contribs)

(dif) ← Versão anterior | ver versão atual (dif) | Versão posterior → (dif)
Ir para: navegação, pesquisa

Tabela de conteúdo


O comando Lista Usuários utilizado para buscar a lista de usuários cadastrados no intercomunicador.

Comando

MÉTODO: GET

Parâmetros enviados para o intercomunicador
request users
Resposta enviada pelo o intercomunicador
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
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: MII/PermissõesDeAcesso
perm2 Permissão de acesso 2 - Veja mais sobre as permissões no link: MII/PermissõesDeAcesso
perm3 Permissão de acesso 3 - Veja mais sobre as permissões no link: MII/PermissõesDeAcesso
perm4 Permissão de acesso 4 - Veja mais sobre as permissões no link: MII/PermissõesDeAcesso
perm5 Permissão de acesso 5 - Veja mais sobre as permissões no link: MII/PermissõesDeAcesso
lifecount Define a quantidade de vezes que o usuário terá o acesso liberado no intercomunicador. 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.
  • 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. Máximo 32 caracteres.
interface Mascara de 32 bits com permissão de acesso para o usuário.
  • Bit 1': Permissão de acesso a interface de acionamento 1 do intercomunicador.
  • Bit 2: Permissão de acesso a interface de acionamento 2 do intercomunicador.
  • Bit 3 a 32: Permissão de acesso a interface externa . Leitor ou intercomunicador slave. Ver Leitores Externos

Exemplos:

  1. 00000001 - Bit 1, acesso a interface de acionamento 1 do intercomunicador.
  2. 00000002 - Bit 1, acesso a interface de acionamento 2 do intercomunicador.
  3. 00000003 - Bit's 1 e 2, acesso a interface de acionamento 1 e 2 do intercomunicador.
  4. 0000007F - Bit's 1, 2, 3, 4, 5, 6 e 7, acesso a interface de acionamento 1 e 2 do intercomunicador e interfaces , 4, 5, 6 e 7 de leitores externos.
NOTA1: Se o valor for 0 (zero), o usuário tem permissão para TODAS as interfaces.

NOTA2: Valores em base 16 - hexadecimal.

administrator Define se o usuário tem permissão de administrador. Usuário com permissão de administrado poderá gerenciar o intercomunicador 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.
  • 5 a 32: Interfaces de acionamento externa 1 a 20. Ver Leitores
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": "1",
        "name":"Rivarola Catalino Mendes",
        "user":"1000",
        "password":"1234",
        "card":"",
        "qrcode":"83009a8d0ecb6a88cab42a1d4c3ed47d",
        "rfcode":"",
        "fingerprint":"",
        "validity:":"0",
        "lifecount":"0",
        "accessibility":"false",
        "panic":"false",
        "key":"b02632",
        "interface": "0000007f",
        "administrator":"false",
        "email":"test@exemplo.com",
        "apn":"",
        "fcm":"",
        "visitor":"false"
    },
    {
        "id": "2",
        "name":"Francisco Javier Arce Rolon",
        "user":"1001",
        "password":"2345",
        "card":"20394857",
        "qrcode":"7d55b677f97a417c6cc9bfa1c3f74d1c",
        "rfcode":"",
        "fingerprint":"",
        "validity:":"0",
        "lifecount":"0",
        "accessibility":"false",
        "panic":"false",
        "key":"26ab0d",
        "interface": "0000001"
        "administrator":"false",
        "email":"test@exemplo.com",
        "apn":"",
        "fcm":"",
        "visitor":"false"
    },
    {
        "id": "3",
        "name":"Edi Wilson José dos Santos",
        "user":"1001",
        "password":"3456",
        "card":"71283940",
        "qrcode":"9b2d929bd31ddd0823c681d8643eae7a",
        "rfcode":"",
        "fingerprint":"",
        "validity:":"0",
        "perm1":"1-5 08:00-18:00",
        "lifecount":"0",
        "accessibility":"false",
        "panic":"false",
        "key":"6d7fce",
        "interface": "0000001"
        "administrator":"false",
        "email":"test@exemplo.com",
        "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


Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas