Skip to content

API pública TiqueTaque (2.1)

Autenticação

Para todas as requisições é necessária a autenticação com um token gerado a partir da plataforma do gestor, utilizando o token com autenticação **BasicAuth** sendo user=*public*, senha=*seu_token*. Verifique a seção de integrações do TiqueAdmin para gerar o token.

Rate limiting

Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto. Se o limite for excedido, será retornada uma resposta HTTP 429 Too Many Requests.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.tiquetaque.app/_mock/openapi
https://api.tiquetaque.com/v2.1

Afastamentos

Operações referentes aos afastamentos de um funcionário.

Operations

Escalas

Informações dos cadastros de escalas de trabalho.

Operations

Funcionários

Operações sobre os cadastros de funcionários.

Operations

Registros de ponto

Informações referentes aos registros de ponto.

Operations

Adiciona um registro de ponto

Request

Adiciona um registro por vez para o funcionário na data e hora passada. Este registro é armazenado como um registro com type='registro externo'.

IMPORTANTE: Os registros de um funcionário mesmo que inseridos com sucesso por este endpoint, serão exibidos na interface do admin TiqueTaque apenas se o cadastro do funcionário possuir uma escala e um empregador configurados. Depois de configurados os campos os registros previamente adicionados serão exibidos também.
Os campos employee_id e employee_external_id são mutuamente exclusivos no corpo da requisição.

Security
BasicAuth
Bodyapplication/json
employee_idstring
employee_external_idstring
timestring(IsoDateTimeModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}$
Example: "2024-09-09T08:00"
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/times \
  -H 'Content-Type: application/json' \
  -d '{
    "employee_id": "string",
    "employee_external_id": "string",
    "time": "2024-09-09T08:00"
  }'

Responses

OK

Bodyapplicaton/json
_statusstring
Example: "OK"
employeestring
Example: "fff5bc225b511a6edec2873ff"
timestring(IsoDateTimeModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}$
Example: "2024-09-09T08:00"
Response
applicaton/json
{
  "_status": "OK",
  "employee": "fff5bc225b511a6edec2873ff",
  "time": "2024-09-09T08:00"
}

Registros de ponto

Request

Retorna os detalhes dos registros para o funcionário solicitado, dentro do intervalo, o formato da resposta é o seguinte:

{
   "employee_id": "5f5bc225b511a6e44c2891f6",
   "times": [
       { 
           "approved": true, 
           "justification": "Esqueci de registrar", 
           "time": "2024-09-02T07:32", 
           "type": "ajuste manual" 
       },
       { 
           "approved": true, 
           "justification": "Registro via app com geolocalização", 
           "time": "2024-09-02T11:59", 
           "type": "app" 
       } 
   ] 
}
ChaveDescrição
employeeID do funcionário.
timesLista de registros de ponto encontrados para o funcionário.
Os valores para cada um dos itens da lista de times são:
  • approved: [true, false]. Indica se o registro já está aprovado pelo gestor.
  • type: [pré-assinalado, aparelho, web, desconsiderado,app, reconhecimento facial, ajuste manual, offline, registro externo]
  • time: Data e hora no format YYYY-MM-DDTHH:MM
  • justification: justificativa do registro, caso exista.
Security
BasicAuth
Query
employee_idstring

ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

employee_external_idstring

ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

start_datestring(date)(DateParamModel)required

Data inicial.

Example: start_date=YYYY-MM-DD
end_datestring(date)(DateParamModel)required

Data final.

Example: end_date=YYYY-MM-DD
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/times?employee_id=string&employee_external_id=string&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD'

Responses

Resposta de sucesso, com detalhes dos registros de ponto. Os exemplos mostrams os valores de resposta possíveis.

Bodyapplication/json
employee_idstring

ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

Example: "5f5bc225b511a6e44c2891f6"
employee_external_idstring

ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

timesArray of objects

Lista de registros de ponto.

Response
application/json
{
  "employee_id": "5f5bc225b511a6e44c2891f6",
  "times": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Empregadores

Operações relacionadas aos empregadores.

Operations

Espelhos de ponto

Dados relativos à um período de espelho de ponto, como totais trabalhados, horas extras, banco de horas e afastamentos.

Operations

Unidades

Cadastros de unidades.

Operations

Usuários

Operações sobre os cadastros de usuários.

Operations