MCP/API/CmdAdicionarUsuario
De uTech Tecnologia
(Diferença entre revisões)
(→Comando) |
|||
(8 edições intermediárias de um usuário não apresentadas) | |||
Linha 5: | Linha 5: | ||
== Comando == | == Comando == | ||
+ | |||
+ | {| style="width: 100%; background-color: orange;" | ||
+ | | '''NOTA:''' É mandatório utilizar o parâmetro '''user''' ou o parâmetro '''id''' (se não utilizar o parâmetro key) | ||
+ | |} | ||
<BR\> | <BR\> | ||
Linha 83: | Linha 87: | ||
* '''true''': É visitante. | * '''true''': É visitante. | ||
* '''false''': Não é visitante. | * '''false''': Não é visitante. | ||
+ | {| style="width: 100%; background-color: orange;" | ||
+ | | '''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 MCP. | ||
+ | |} | ||
+ | |- | ||
+ | | align="left"| relay || Identificação do relê associado ao usuário. | ||
+ | * '''1''': Interface de acionamento 1 - '''READER 1'''. | ||
+ | * '''2''': Interface de acionamento 2 - '''READER 2'''. | ||
+ | * '''3''': Interface de acionamento 3 - '''READER 3'''. | ||
+ | * '''4''': Interface de acionamento 4 - '''READER 4'''. | ||
+ | * '''5 a 32''': Interfaces de acionamento externa 1 a 20. Ver [[MCP/ConfiguracaoWEB#Leitores|'''Leitores''']] | ||
+ | |- | ||
+ | | 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. | ||
+ | |- | ||
+ | | align="left"| apn || Código ''push'' para envio de notificações para aplicações iOS®. | ||
+ | |- | ||
+ | | align="left"| fcm || Código push para envio de notificações para aplicações Android®. | ||
+ | |- | ||
+ | | align="left"| face || Identificação da face do usuário. Utilizado para integração com porteiros/Leitores com reconhecimento facial externo. O campo aceita: | ||
+ | * '''Modelo da face''': Modelo da face codificado em base64. | ||
+ | * '''Imagem da face''': Imagem codificada em base64. '''SOMENTE''' imagem PNG ou JPEG com, no '''MÁXIMO''' 100kB | ||
+ | <BR> | ||
+ | '''Exemplos''': | ||
+ | * '''Modelo''': {"user":"1234","face":"RlI1MDAwMDUBAAAAAAAAAPrLgwaSOS2FPxgIQMQgjKEas3ds...="} | ||
+ | * '''Imagem''': {"user":"1234","face":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA..."} | ||
|} | |} | ||
Linha 92: | Linha 131: | ||
'''{"id":"1","key":"26ab0d"} | '''{"id":"1","key":"26ab0d"} | ||
<BR> | <BR> | ||
− | |||
== Exemplo == | == Exemplo == | ||
Linha 112: | Linha 150: | ||
"panic":"false", | "panic":"false", | ||
"key":"26ab0d", | "key":"26ab0d", | ||
− | "interface": "0000007f" | + | "interface": "0000007f", |
+ | "face":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA..." | ||
} | } | ||
</pre> | </pre> | ||
Linha 158: | Linha 197: | ||
"card" => "af23d66529acbd", | "card" => "af23d66529acbd", | ||
"qrcode" => "b15c4c36b924645d023c2f13dec7a028", | "qrcode" => "b15c4c36b924645d023c2f13dec7a028", | ||
− | "validity | + | "validity" => "0", |
"lifecount" => "0", | "lifecount" => "0", | ||
"accessibility" => "false", | "accessibility" => "false", | ||
Linha 166: | Linha 205: | ||
); | ); | ||
− | $data_string = json_encode($data); | + | $data_string = json_encode($data,JSON_UNESCAPED_SLASHES); |
$url = "$ipaddr:$port?request=adduser"; | $url = "$ipaddr:$port?request=adduser"; | ||
$ch = curl_init($url); | $ch = curl_init($url); |
Edição atual tal como 13h17min de 11 de junho de 2024
Tabela de conteúdo |
O comando Adicionar usuário é utilizado inserir um novo usuário no controle de acesso da central MCP
[editar] Comando
NOTA: É mandatório utilizar o parâmetro user ou o parâmetro id (se não utilizar o parâmetro key) |
MÉTODO: POST
Parâmetros enviados para a central MCP | |
---|---|
request | adduser |
POST-DATA:
Parâmetros enviados para a central MCP 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) | |
perm1 | Permissão de acesso 1 - Veja mais sobre as permissões no link: MCP/PermissõesDeAcesso | |
perm2 | Permissão de acesso 2 - Veja mais sobre as permissões no link: MCP/PermissõesDeAcesso | |
perm3 | Permissão de acesso 3 - Veja mais sobre as permissões no link: MCP/PermissõesDeAcesso | |
perm4 | Permissão de acesso 4 - Veja mais sobre as permissões no link: MCP/PermissõesDeAcesso | |
perm5 | Permissão de acesso 5 - Veja mais sobre as permissões no link: MCP/PermissõesDeAcesso | |
lifecount | Define a quantidade de vezes que o usuário terá o acesso liberado na central MCP. 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. | |
interface | Mascara de 32 bits com permissão de acesso para o usuário.
Exemplos:
| |
administrator | Define se o usuário terá permissões de administrados. Usuário administrador poderá utilizar funções de configurações da placa, omo inserir novos usuários.
| |
Endereço de e-mail do usuário. utilizado para envio de notificações. Ver Notificações. | ||
vcard | Identificação do cartão veicular do usuário. | |
vplate | Identificação da placa do veículo. | |
visitor | Define se o usuário é visitante ou não.
| |
relay | Identificação do relê associado ao usuário.
| |
finger | Identificação do dedo utilizado na biometria. Este campo DEVE. É utilizado uma letra para identificação do dedo:
| |
apn | Código push para envio de notificações para aplicações iOS®. | |
fcm | Código push para envio de notificações para aplicações Android®. | |
face | Identificação da face do usuário. Utilizado para integração com porteiros/Leitores com reconhecimento facial externo. O campo aceita:
|
Resposta:
A resposta será um JSON com o id da base do Porteiro e com a chave primária (key) enviada no comando, conforme mostrado abaixo:
{"id":"1","key":"26ab0d"}
[editar] Exemplo
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", "face":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA..." } |
---|
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
[editar] 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" ); $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; } echo "$rc\n"; ?> |