Passar para o conteúdo principal

API - Apontamentos

Neste artigo, verá o uso dos endpoints da API da TWO relacionados a Apontamentos.

Jorge Luis avatar
Escrito por Jorge Luis
Atualizado essa semana

1. Listar Apontamentos

Endpoint:

GET https://api1.tradingworks.net/v1/attendances

Headers:

AUTH-TOKEN: sua_chave_privada

Parâmetros (opcionais):

Campo

Tipo

Exemplo

Observações

Language

string

"pt-BR"

Define idioma dos campos retornados. Valores: "en-US" (padrão), "pt-BR".

FromDate

date

"2020-09-01"

Data de início da busca. Máximo de 120 dias entre FromDate e ToDate.

ToDate

date

"2020-09-30"

Data de fim da busca.

ListAll

boolean

true

Se true, traz os últimos 60 dias de marcações, independentemente da sincronização (limite de 1.000 registros).

ShowMeta

boolean

false

Se true, inclui metadados extras como validação facial e geolocalização.


2. Marcar Apontamento como Sincronizado

Endpoint:

POST https://api1.tradingworks.net/v1/attendances/setsync

Headers:

AUTH-TOKEN: sua_chave_privada Content-Type: application/json

Dados (JSON body):

Campo

Tipo

Requerido

Exemplo

Observações

AttendanceRegisterID

integer

Sim

240341

ID do registro de ponto para ser marcado como sincronizado.

Exemplo de requisição:

[
{ "AttendanceRegisterID": 240341 },
{ "AttendanceRegisterID": 240348 },
{ "AttendanceRegisterID": 240362 }
]

3. Adicionar Apontamento

Endpoint:

POST https://api1.tradingworks.net/v1/attendances/add

Headers:

AUTH-TOKEN: sua_chave_privada Content-Type: application/json

Dados (JSON body):

Campo

Tipo

Requerido

Exemplo

Observações

NumeroREP

string

Não

"98765"

Código do equipamento (REP), usado para auditoria.

NSR

string

Não

"1234"

Número sequencial de registro (para fins de auditoria).

CPF

string

Sim

"12345678900"

CPF do colaborador (sem pontuação).

DataMarcacao

string

Sim

"2023-10-01"

Data da marcação no formato YYYY-MM-DD.

HoraMarcacao

string

Sim

"22:34"

Hora da marcação, formato 24h (hh:mm).

Exemplo de requisição com vários apontamentos:

[
{
"NumeroREP": "098765",
"NSR": "1234",
"CPF": "12345678900",
"DataMarcacao": "2023-10-01",
"HoraMarcacao": "14:56"
},
{
"NumeroREP": "098765",
"NSR": "1235",
"CPF": "12345678900",
"DataMarcacao": "2023-10-01",
"HoraMarcacao": "19:07"
}
]

Observações Importantes

  • A listagem retorna até 1.000 apontamentos, que ainda não foram marcados como sincronizados e são apenas os registros originais (pelo colaborador ou aprovados pelo gestor/RH).

  • Os campos FromDate e ToDate têm limite máximo de 120 dias entre si.

  • O parâmetro ListAll = true traz os últimos 60 dias de marcações, mesmo que já sincronizadas.

  • Parâmetro ShowMeta = true inclui informações como validação facial, geolocalização e status de GPS.

  • Ao marcar como sincronizado, o apontamento é removido da listagem futura.

  • O endpoint de adição permite registrar pontos vindos de equipamentos homologados, com auditoria via REP/NSR.

Respondeu à sua pergunta?