View
5
Download
0
Category
Preview:
Citation preview
1
Registrador Eletrônico de Ponto
Marque Ponto – G3
Lista de Comandos
Rev. 1.1
2
Sumário 1. Lista de comandos ............................................................................................................................ 4
1.1. Lê data e hora ........................................................................................................................... 4
1.2. Lê status da MRP ...................................................................................................................... 4
1.3. Inicia transferência de todos os registros do REP ................................................................... 5
1.4. Inicia a transferência dos registros das últimas 24 horas ....................................................... 5
1.5. Inicia a transferência de todos os registros efetuados num intervalo de tempo .................. 6
1.6. Inicia a transferência de todos os registros efetuados num intervalo de tempo .................. 6
1.7. Inicia a transferência de todos os registros dado um intervalo de NSR ................................. 7
1.8. Recebe registros ....................................................................................................................... 7
1.9. Finaliza a transmissão de registros .......................................................................................... 8
1.10. Lê firmware criptografado contido no intervalo de memória ............................................ 8
1.11. Lê hash do firmware contido no intervalo de memória...................................................... 8
1.12. Lê empregador cadastrado .................................................................................................. 9
1.13. Lê registro do empregado por PIS ........................................................................................ 9
1.14. Lê registro do empregado por ID ....................................................................................... 10
1.15. Lê registro do empregado por keyboard ........................................................................... 10
1.16. Lê registro do empregado por contactless ........................................................................ 11
1.17. Lê registro do empregado por biometria........................................................................... 11
1.18. Inicia a transferência dos registros de empregados .......................................................... 12
1.19. Recebe os dados dos registros de empregados ................................................................. 12
1.20. Status da MT ....................................................................................................................... 13
1.21. Retorna os IDs de biometria de um empregado ............................................................... 13
1.22. Retorna o template da biometria ...................................................................................... 14
1.23. Configura data e hora ......................................................................................................... 14
1.24. Inicializa a NFR .................................................................................................................... 15
1.25. Configura o empregador .................................................................................................... 15
1.26. Edita o empregador ............................................................................................................ 16
1.27. Configura um empregado ................................................................................................... 16
1.28. Configura um empregado ................................................................................................... 17
1.29. Remove um empregado ..................................................................................................... 17
1.30. Altera a senha ..................................................................................................................... 18
1.31. Envia assinatura do firmware de atualização .................................................................... 18
1.32. Atualiza firmware ............................................................................................................... 19
3
1.33. Grava template de biometria ............................................................................................. 19
2. Lista de erros ................................................................................................................................... 20
4
1. Lista de comandos
1.1. Lê data e hora
URL /MRP/RTC/GetTime
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “DD/MM/AA HH:MM:SS”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.2. Lê status da MRP
URL /MRP/Status
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo
String no formato: “NFR: [17 digitos]; Free Size: [int]; Used Size: [int]; Version: XXX.YYY.ZZZ; Build: [data/hora]; Flags: [int];First Reg:[data (DDMMYYYY)];Last Reg:[data (DDMMYYYY)];Last NSR:[int]”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
5
1.3. Inicia transferência de todos os registros do REP
URL /MRP/Regs/All
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int];TotalSize:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Este recurso não retorna nenhum registro em si, apenas dá início a transferência dos mesmos.
1.4. Inicia a transferência dos registros das últimas 24 horas
URL /MRP/Regs/Last24hs
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int];TotalSize:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Este recurso não retorna nenhum registro em si, apenas dá início a transferência dos mesmos.
6
1.5. Inicia a transferência de todos os registros efetuados num intervalo de tempo
URL /MRP/Regs/DateRange/FROM/:from/TO/:to
Método GET
Parâmetros de URL
from=[data no formato DDMMYY]
to=[data no formato DDMMYY]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int];TotalSize:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Este recurso não retorna nenhum registro em si, apenas dá início a transferência dos mesmos.
1.6. Inicia a transferência de todos os registros efetuados num intervalo de tempo
URL /MRP/Regs/DateRange/FROM/:from/TO/:to
Método GET
Parâmetros de URL
from=[data no formato DDMMYY]
to=[data no formato DDMMYY]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int];TotalSize:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Este recurso não retorna nenhum registro em si, apenas dá início a transferência dos mesmos.
7
1.7. Inicia a transferência de todos os registros dado um intervalo de NSR
URL /MRP/Regs/NsrRange/FROM/:from/TO/:to
Método GET
Parâmetros de URL
from=[int] to=[int]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int];TotalSize:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Este recurso não retorna nenhum registro em si, apenas dá início a transferência dos mesmos.
1.8. Recebe registros
URL /MRP/Regs/NextReg
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “BlockIndex:[int];BlockSize:[int]; {[24 digitos ]\r\n...[BlockSize vezes]\r\n};”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
8
1.9. Finaliza a transmissão de registros
URL /MRP/Regs/Finish
Método GET
Parâmetros de URL
from=[hexadecimal representando um endereço de memória] to=[hexadecimal representando um endereço de memória]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “Session:[int] Closed”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.10. Lê firmware criptografado contido no intervalo de memória
URL /MRP/FW/FROM/:from/TO/:to
Método GET
Parâmetros de URL
from=[hexadecimal representando um endereço de memória] to=[hexadecimal representando um endereço de memória]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “String Hexadecimal”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.11. Lê hash do firmware contido no intervalo de memória
URL /MRP/Hash/FROM/:from/TO/:to
Método GET
Parâmetros de URL
from=[hexadecimal representando um endereço de memória] to=[hexadecimal representando um endereço de memória]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “String Hexadecimal”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
9
1.12. Lê empregador cadastrado
URL /MT/Employer
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “CNPJ:[14 digitos];CEI:[12 digitos];NOME:[150 alfanumérico];END:[100 alfanumérico];TIPO:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.13. Lê registro do empregado por PIS
URL /MT/Employee/PIS/:pis
Método GET
Parâmetros de URL
pis=[12 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
10
1.14. Lê registro do empregado por ID
URL /MT/Employee/ID/:id
Método GET
Parâmetros de URL
id=[8 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.15. Lê registro do empregado por keyboard
URL /MT/Employee/KBD/:kbd
Método GET
Parâmetros de URL
kbd=[8 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
11
1.16. Lê registro do empregado por contactless
URL /MT/Employee/CNTLS/:cntls
Método GET
Parâmetros de URL
cntls=[16 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo
String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];” String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.17. Lê registro do empregado por biometria
URL /MT/Employee/BIO/:bio
Método GET
Parâmetros de URL
bio=[int (0 - 10000)]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “NOME:[52 alfanum];PIS:[12 dígitos];CNTLS:[16 dígitos];KBD:[8 dígitos];ID:[8 dígitos];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
12
1.18. Inicia a transferência dos registros de empregados
URL /MT/Employee/GetAll
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “ENROLLED EMPLOYEES:[int];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.19. Recebe os dados dos registros de empregados
URL /MT/Employee/GetNext
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “{\r\n[(Nome) 52 alfanum],[(PIS) 12 digitos],[(ID) 8 digitos],[(CNTLS) 16 dígitos],[(KBD) 8 dígitos];\r\n...}\r\n”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
13
1.20. Status da MT
URL /MT/GetStatus
Método GET
Parâmetros de URL
Nenhum
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo
String no formato: “ENROLLED EMPLOYEES:[int];FREE
EMPLOYEES:[int];AVAIABLE MEMORY:[int];ENROLLED
EMPLOYER:[bool];”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.21. Lê os IDs de biometria de um empregado
URL /FP/Template/GetEnroll/PIS/:pis
Método GET
Parâmetros de URL
pis=[12 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “NUM:[int];ID:[int]; ID:[int];ID:...”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
14
1.22. Lê o template da biometria
URL /FP/Template/GetTemplate/ID/:id
Método GET
Parâmetros de URL
id=[8 digitos]
Parâmetros de dados
Nenhum
Resposta com Sucesso
Código 200
Conteúdo String no formato: “TEMPLATE:{[String em base 64]};”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.23. Configura data e hora
URL /MRP/SetNFR
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
HORA=[2 digitos] MIN=[2 digitos] SEG=[2 digitos] DIA=[2 digitos] MES=[2 digitos] ANO=[2 digitos] AUT=[11 digitos;Hash] Exemplo: HORA=14&MIN=03&SEG=58&DIA=27&MES=04&ANO=15& AUT=11111111111;6402A0458A221AA959249721631EC216
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
15
1.24. Inicializa a NFR
URL /MRP/SetNFR
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
NFR=[17 digitos] Exemplo: NFR=12345678901234567
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.25. Configura o empregador
URL /MT/Employer/SetEmployer
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
CNPJ=[14 digitos] CEI=[12 digitos] TIPO=[int] NOME=[150 alfanum] END=[100 alfanum] AUT=[11 digitos;Hash] Exemplo: CNPJ=03654119000176&CEI=01234567890&TIPO=1&NOME=GERTEC%20 BRASIL%20LTDA&END=AV%2E%20JABAQUARA%2C%203060%20%2D%20SAO %20PAULO&AUT=11111111111;FBA80F6D675D6FBF7CA59EB17201D761
Resposta com
Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
16
1.26. Edita o empregador
URL /MT/Employer/EditEmployer
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
CNPJ=[14 digitos] CEI=[12 digitos] TIPO=[int] NOME=[150 alfanum] END=[100 alfanum] AUT=[11 digitos;Hash] Exemplo: CNPJ=03654119000176&CEI=01234567890&TIPO=1&NOME=GERTEC %20LTDA&END=AV%2E%20JABAQUARA%2C%206030%20%2D%20SAO %20PAULO&AUT=11111111111;772284B065C6143DE047D122DC9D24B9
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.27. Configura um empregado
URL /MT/Employee/SetEmployee
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
PIS=[12 digitos] ID=[8 digitos] NOME=[52 alfanum] CNTLS=[16 digitos] KBD=[8 digitos] AUT=[11 digitos;Hash] Exemplo: PIS=31166994324&ID=2351889&NOME=Funcion%E1rio%2023519& CNTLS=DEEE1AA7D7&KBD=1& AUT=11111111111;69DBDEA4CAE67CA50B335F9B79E3B82A
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
17
1.28. Configura um empregado
URL /MT/Employee/EditEmployee
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
PIS=[12 digitos] ID=[8 digitos] NOME=[52 alfanum] CNTLS=[16 digitos] KBD=[8 digitos] AUT=[11 digitos;Hash] Exemplo: PIS=80121982074&ID=7791331&NOME=Funcion%E1rio%2076543& CNTLS=70B8020552&KBD=5& AUT=11111111111;AB6D0C4BDFE4843FF02F2816767D4B4D
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.29. Remove um empregado
URL /MT/Employee/RemoveEmployee
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
PIS=[12 digitos] AUT=[11 digitos;Hash] Exemplo: PIS=80121982074& AUT=11111111111;EB3A8B82CAA2A89110A2A02C9F616D4D
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
18
1.30. Altera a senha
URL /USER/SetPasswd
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
PSSWD=[8 digitos] AUT=[11 digitos;Hash] Exemplo: PSSWD=1111& AUT=11111111111;835306D7E10BB8E5D84358F06B561F18
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.31. Envia assinatura do firmware de atualização
URL /FWUPDATE
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
SIGN=[Assinatura do firmware de atualização (512 caracteres hexadecimais)] AUT=[11 digitos;Hash]
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
19
1.32. Atualiza firmware
URL /PostUpdateVersion
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
[Firmware de atualização em formato binário]
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas
1.33. Grava template de biometria
URL /FP/SetTemplate
Método POST
Parâmetros de URL
Nenhum
Parâmetros de dados
PIS=[12 digitos] SIZE=[4 digitos] TEMP1=[512 digitos:String em base 64] TEMP2=[512 digitos:String em base 64] TEMP3=[512 digitos:String em base 64] TEMP4=[512 digitos:String em base 64] AUT=[11 digitos;Hash] Exemplo: PIS=31166994324&SIZE=1024&TEMP1=[String em base 64] &TEMP2=[String em base 64]&TEMP3=&TEMP4=& AUT=11111111111;835306D7E10BB8E5D84358F06B561F18
Resposta com Sucesso
Código 200
Conteúdo String no formato: “OK”
Resposta com Erro
Código 200
Conteúdo String no formato: “ERROR:X”
Notas Todas as tags devem ser enviadas
20
2. Lista de erros
Código Descrição
200 MT_RES_OK
201 MT_RES_ERROR_ENROLLED_EMPLOYER
202 MT_RES_ERROR_NOT_ENROLLED_EMPLOYER
203 MT_RES_ERROR_ENROLLED_PIS
204 MT_RES_ERROR_ENROLLED_ID
205 MT_RES_ERROR_NOT_ENROLLED_EMPLOYEE
206 MT_RES_ERROR_ENROLLED_CONTACTLESS
207 MT_RES_ERROR_ENROLLED_BARCODE
208 MT_RES_ERROR_ENROLLED_KEYBOARD
209 MT_RES_ERROR_RECORD
210 MT_RES_ERROR_FORMAT
211 MT_RES_ERROR_FLASH_SIZE
212 MT_RES_ERROR_INVALID_NAME
213 MT_RES_ERROR_INVALID_PIS
214 MT_RES_ERROR_INVALID_ID
215 MT_RES_ERROR_INVALID_BIOID
216 MT_RES_ERROR_INVALID_CONTACTLESS
217 MT_RES_ERROR_INVALID_BARCODE
218 MT_RES_ERROR_INVALID_KEYBOARD
219 MT_RES_ERROR_PARAMETER
220 MT_RES_ERROR_NO_ID_DATA
221 MT_RES_ERROR_INVALID_DATA
222 MT_RES_ERROR_INVALID_HASH_ADDRESS
223 MT_RES_ERROR_NOT_IN_USE_RECORD
224 MT_RES_ERROR_INVALID_CNPJ
225 MT_RES_ERROR_INVALID_CPF
226 MT_RES_ERROR_INVALID_CEI
227 MT_RES_ERROR_INVALID_EMPLOYER_TYPE
228 MT_RES_ERROR_UNENROLL_EMPLOYEE
229 MT_RES_ERROR_MAX_BIO_IDS_ENROLLED
230 MT_RES_ERROR_NO_FREE_SPACE
231 MT_RES_ERROR_INIT
Recommended