MII/API/CmdAdicionarUsuario

De uTech Tecnologia
Edição feita às 13h05min de 11 de junho 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 Adicionar usuário é utilizado inserir um usuário no controle de acesso do intercomunicador

Comando

NOTA: É mandatório utilizar o parâmetro user ou o parâmetro id


MÉTODO: POST

Parâmetros enviados para o intercomunicador
request adduser

POST-DATA:

Parâmetros enviados para o intercomunicador via JSON
name Nome do usuário.
user Login do usuário.
password Senha do usuário.
card Identificação de acesso via cartão MIFARE / NFC
qrcode Identificação de acesso via QR Code
rfcode Identificação de acesso via RF 433 (Controle)
fingerprint Identificação de acesso via biometria
validity Tempo em segundos para expirar as permissões do usuário (0 - Desabilitado)
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.
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. 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.
NOTA: Ao selecionar o usuário como visitante (true) DEVE-SE configurar as permissões de acesso com DATA e HORA. em um dos campos perm1, perm2, perm3, perm4 ou perm5. Após expirado o prazo para de validade do usuário (DATA/HORA), o usuário será automaticamente removido da base de usuários do intercomunicador.
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
finger Identificação do dedo utilizado na biometria. É 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.


Resposta:

A resposta será um JSON com o id da base do intercomunicador e com a chave primária (key) enviada no comando, conforme mostrado abaixo:
{"id":"1","key":"26ab0d"}

Exemplo

Envio:

POST /?request=adduser HTTP/1.1
Content-Type: application/json
Content-Length: 167

{"name":"Teste",
 "user":"1005",
 "password":"8989",
 "card":"af23d66",
 "qrcode":"b15c4",
 "validity:":"0",
 "lifecount":"0",
 "accessibility":"false",
 "panic":"false",
 "key":"26ab0d",
 "interface": "0000007f",
 "administrator":"false",
 "email":"  ",
 "apn":"",
 "fcm":"",
 "visitor":"true,
 "perm1":"2019/4/17-2019/4/19 8:0-18:0"
}

Resposta:


HTTP/1.1 200 OK
Content-Length: 25
Content-Type: application/json; charset=iso-8859-1
Date: Wed, 03 Jan 2007 21:52:54 GMT

{"id":"1","key":"26ab0d"}

Return code:

  • 400 => Parâmetros incorretos
  • 401 => Erro de autenticação da API
  • 500 => Falha no comando
  • 200 => OK




PHP

<?php
 
$user = "utech";
$pass = "1234";
$port = "8080";
$ipaddr = "10.0.0.1";
 
$data = array(
    "name"          => "Arilson Gilberto da Costa",
    "user"          => "1005",
    "password"      => "8989",
    "card"          => "af23d66529acbd",
    "qrcode"        => "b15c4c36b924645d023c2f13dec7a028",
    "validity:"     => "0",
    "lifecount"     => "0",
    "accessibility" => "false",
    "panic"         => "false",
    "key"           => "26ab0d",
    "interface"     => "0000007f",
    "administrator" => "false",
    "email"         => "test@exemplo.com",
    "apn"           => "",
    "fcm"           => "",
    "visitor"       => "false",
    "perm1"         => "2019/4/17-2019/4/19 8:0-18:0"
);
 
$data_string = json_encode($data,JSON_UNESCAPED_SLASHES);
$url = "$ipaddr:$port?request=adduser";
$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 "500":
        echo "500 => Falha no comando\n";
    break;
 
    case "200":
        echo "200 => OK\n";
    break;
 
    default:
        echo "Return Code: $rc\n";
}
 
?>




Voltar


Ferramentas pessoais
Espaços nominais

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