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

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

Cria um novo usuário.

Request

Cria um novo usuário.

Security
BasicAuth
Bodyapplication/json
full_namestring

Nome completo.

Example: "Exemplo da Silva"
emailstring

Endereço de e-mail.

Example: "exemplo@tiquetaque.com"
external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

mobile_phonestring

Número de telefone celular com código de área, somente números.

Example: "11991234567"
intercom_chatboolean

Habilita o chat intercom para o usuário.

rolestring(RoleModel)
Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema,  como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões;  lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador,  porém apenas para as unidades selecionadas.
- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
- read-only: Pode apenas: visualizar os dados das unidades selecionadas. ```
Example: "admin-supervisor"
allowed_sitesArray of strings(AllowedSitesModel)

Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública o recurso de unidades, isto será adicionado futuramente.

Example: ["id_1","id_2"]
permissionsobject(UserPermissionsModel)

Configurações de permissões de usuário.

curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/users \
  -H 'Content-Type: application/json' \
  -d '{
    "full_name": "Exemplo da Silva",
    "email": "exemplo@tiquetaque.com",
    "external_id": "string",
    "mobile_phone": "11991234567",
    "intercom_chat": true,
    "role": "admin-supervisor",
    "allowed_sites": [
      "id_1",
      "id_2"
    ],
    "permissions": {
      "allow_ws_edition": true
    }
  }'

Responses

Dados atualizados com sucesso.

Bodyapplication/json
_idstring
_createdstring(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

_statusstring
Example: "OK"
Response
application/json
{
  "_id": "string",
  "_created": "2024-09-09T08:00-03:00",
  "_etag": "string",
  "_status": "OK"
}

Lista usuários da conta

Request

Retorna uma lista com os usuários da conta.

Security
BasicAuth
Query
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/users?max_results=25&page=1'

Responses

Lista de usuários.

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

Detalhes de um usuário

Request

Retorna um usuário específico.

Security
BasicAuth
Path
idstringrequired

ID do usuário.

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

Responses

Usuário encontrado.

Bodyapplication/json
_idstring

Identificador único do recurso, gerado internamente.

_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"
full_namestring

Nome completo.

Example: "Exemplo da Silva"
emailstring

Endereço de e-mail.

Example: "exemplo@tiquetaque.com"
mobile_phonestring

Número de telefone celular com código de área, somente números.

Example: "11991234567"
external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

intercom_chatboolean

Indica se o chat do intercom no TiqueAdmin está habilitado para este usuário.

verified_userboolean

Indica se a conta do usuário já foi verificada através do email de ativação.

Example: true
rolestring(RoleModel)
Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema,  como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões;  lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador,  porém apenas para as unidades selecionadas.
- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
- read-only: Pode apenas: visualizar os dados das unidades selecionadas. ```
Example: "admin-supervisor"
allowed_sitesArray of strings(AllowedSitesModel)

Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública o recurso de unidades, isto será adicionado futuramente.

Example: ["id_1","id_2"]
permissionsobject(UserPermissionsModel)

Configurações de permissões de usuário.

Response
application/json
{
  "_id": "string",
  "_created": "2024-09-09T08:00-03:00",
  "_updated": "2024-09-09T08:00-03:00",
  "full_name": "Exemplo da Silva",
  "email": "exemplo@tiquetaque.com",
  "mobile_phone": "11991234567",
  "external_id": "string",
  "intercom_chat": true,
  "verified_user": true,
  "role": "admin-supervisor",
  "allowed_sites": [
    "id_1",
    "id_2"
  ],
  "permissions": {
    "allow_ws_edition": true
  }
}

Atualiza um usuário

Request

Atualiza um usuário específico.

Security
BasicAuth
Path
idstringrequired

ID do usuário.

Headers
If-Matchstringrequired

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

Bodyapplication/json
full_namestring

Nome completo.

Example: "Exemplo da Silva"
emailstring

Endereço de e-mail.

Example: "exemplo@tiquetaque.com"
external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

mobile_phonestring

Número de telefone celular com código de área, somente números.

Example: "11991234567"
intercom_chatboolean

Habilita o chat intercom para o usuário.

rolestring(RoleModel)
Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema,  como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões;  lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador,  porém apenas para as unidades selecionadas.
- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
- read-only: Pode apenas: visualizar os dados das unidades selecionadas. ```
Example: "admin-supervisor"
allowed_sitesArray of strings(AllowedSitesModel)

Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública o recurso de unidades, isto será adicionado futuramente.

Example: ["id_1","id_2"]
permissionsobject(UserPermissionsModel)

Configurações de permissões de usuário.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/users/{id}' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: string' \
  -d '{
    "full_name": "Exemplo da Silva",
    "email": "exemplo@tiquetaque.com",
    "external_id": "string",
    "mobile_phone": "11991234567",
    "intercom_chat": true,
    "role": "admin-supervisor",
    "allowed_sites": [
      "id_1",
      "id_2"
    ],
    "permissions": {
      "allow_ws_edition": true
    }
  }'

Responses

Dados atualizados com sucesso.

Bodyapplication/json
_idstring
_createdstring(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

_statusstring
Example: "OK"
Response
application/json
{
  "_id": "string",
  "_created": "2024-09-09T08:00-03:00",
  "_etag": "string",
  "_status": "OK"
}

Exclui um usuário

Request

Security
BasicAuth
Path
idstringrequired

ID do usuário.

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/users/{id}' \
  -H 'If-Match: string'

Responses

Cadastro excluído com sucesso.

Response
No content