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

Cria um afastamento para um funcionário

Request

Security
BasicAuth
Bodyapplication/json

O afastamento pode ser parcial ou de dia inteiro. Os valores start_time e end_time são opcionais, e devem ser preenchidos caso o afastamento seja parcial. Caso seja de dia inteiro, informar apenas start_date e end_date. Um dos valores entre employee_id e employee_external_id é obrigatório e são mutuamente exclusivos.

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.

typestring(TipoAfastamentoModel)
Enum"abono""afastamento""atestado""dispensa_legal""falta_justificada""falta_injustificada""ferias""folga""inss""suspensao"
start_datestring(date)(DateParamModel)
Example: "YYYY-MM-DD"
end_datestring(date)(DateParamModel)
Example: "YYYY-MM-DD"
start_timestring(TimeParamModel)
Example: "HH:MM"
end_timestring(TimeParamModel)
Example: "HH:MM"
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/work-leaves \
  -H 'Content-Type: application/json' \
  -d '{
    "employee_id": "string",
    "employee_external_id": "string",
    "type": "abono",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "start_time": "HH:MM",
    "end_time": "HH:MM"
  }'

Responses

Afastamento criado com sucesso

Bodyapplication/json
_idstring
_statusstring
Example: "OK"
_createdstring
Response
application/json
{
  "_id": "string",
  "_status": "OK",
  "_created": "string"
}

Retorna uma lista com os afastamentos de um funcionário

Request

Os afastamentos retornados, conforme os filtros aplicados são associados a um funcionário identificado por employee_id. Eles representam variados motivos que fazem com que o funcionário deixe de trabalhar o tempo previsto. Retorna todos os registros de afastamentos que contenham as datas entre start_date e end_date. Resultado paginado

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

Filtro para data de início dos afastamentos.

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

Filtro para data de fim dos afastamentos

Example: end_date=YYYY-MM-DD
typestring(TipoAfastamentoModel)

filtro por tipo de afastamento.

Enum"abono""afastamento""atestado""dispensa_legal""falta_justificada""falta_injustificada""ferias""folga""inss""suspensao"
statusstring(StatusAfastamentoModel)

filtro por situação do afastamento.

Enum"aprovado""pendente""reprovado"
max_resultsinteger(MaxResultsParamModel)

Tamanho da página de resultados paginados.

Default 25
pageinteger(PageParamModel)

Número da página de resultados a retornar

Default 1
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves?employee_id=string&employee_external_id=string&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&type=abono&status=aprovado&max_results=25&page=1'

Responses

Retorna listagem de todos os afastamentos que atendem aos critérios dos filtros.

Bodyapplication/json
_itemsArray of objects(AfastamentoModel)
_linksobject(LinksModel)
_metaobject(MetaModel)
Response
application/json
{
  "_items": [
    { … }
  ],
  "_links": {
    "parent": { … },
    "self": { … }
  },
  "_meta": {
    "max_results": 0,
    "page": 0,
    "total": 0
  }
}

Aprova um afastamento

Request

Security
BasicAuth
Path
idstringrequired

ID do afastamento

Headers
If-Matchstringrequired

Para aprovar um afastamento é necessário o header com o valor do campo _etag atual do documento.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves/{id}/approve' \
  -H 'If-Match: string'

Responses

Dados atualizados com sucesso.

Response
No content

Reprova um afastamento

Request

Security
BasicAuth
Path
idstringrequired

ID do funcionário. Pode ser usado tanto id quanto external_id

Headers
If-Matchstringrequired

Para reprovar um afastamento é necessário o header com o valor do campo _etag atual do documento.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves/{id}/reject' \
  -H 'If-Match: string'

Responses

Dados atualizados com sucesso.

Response
No content

Retorna os dados de um afastamento

Request

Retorna todos campos de

Security
BasicAuth
Path
idstringrequired

ID do afastamento.

curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves/{id}'

Responses

Dados cadastrados para o afastamento.

Bodyapplication/json
_idstring

ID do afastamento

_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example: "2024-09-09T08:00-03:00"
_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example: "2024-09-09T08:00-03:00"
_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

employee_idstring

ID do funcionário

typestring(TipoAfastamentoModel)
Enum"abono""afastamento""atestado""dispensa_legal""falta_justificada""falta_injustificada""ferias""folga""inss""suspensao"
end_datestring(date)
start_datestring(date)
approval_infoobject
Response
application/json
{
  "_id": "string",
  "_created": "2024-09-09T08:00-03:00",
  "_updated": "2024-09-09T08:00-03:00",
  "_etag": "string",
  "employee_id": "string",
  "type": "abono",
  "end_date": "2019-08-24",
  "start_date": "2019-08-24",
  "approval_info": {
    "approved": true,
    "request_date": "2020-05-05T08:28:14+00:00",
    "change_request": { … }
  }
}

Exclui um afastamento

Request

Security
BasicAuth
Path
idstringrequired

ID do afastamento.

Headers
If-Matchstringrequired

Para remover um documento é necessário o header com o valor do campo _etag atual do documento.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves/{id}' \
  -H 'If-Match: string'

Responses

Cadastro excluído com sucesso.

Response
No content

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

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