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

Cria uma nova unidade

Request

Cria uma nova unidade. Unidades agrupam funcionários e podem ser utilizadas para vincular funcionários aos aparelhos TiqueTaque

Security
BasicAuth
Bodyapplication/json
namestring

Nome da unidade.

Example: "Loja Matriz"
geofence_locationobject

Cerca virtual. Ponto lng/lat em conjunto com um raio define uma área onde é permitido o registro de ponto para funcionários vinculados à esta unidade.

timezonestring(TimezoneModel)

Fuso Horário utilizado para controle do horário de registro de ponto.

Enum"America/Araguaina""America/Bahia""America/Belem""America/Boa_Vista""America/Campo_Grande""America/Cuiaba""America/Eirunepe""America/Noronha""America/Fortaleza""America/Maceio"
Example: "America/Sao_Paulo"
employeesArray of arrays
Example: [["5f5bc225b511a6edec2891f7","0c5bc225b511a6edec289199"]]
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/sites \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Loja Matriz",
    "geofence_location": {
      "radius_meters": 30,
      "location": [
        -23.550513,
        -46.633309
      ]
    },
    "timezone": "America/Sao_Paulo",
    "employees": [
      [
        "5f5bc225b511a6edec2891f7",
        "0c5bc225b511a6edec289199"
      ]
    ]
  }'

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"
}

Retorna uma lista com as unidades ativas da conta.

Request

Lista as unidades ativas

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/sites?max_results=25&page=1'

Responses

Lista de usuários.

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

Detalhes de uma unidade

Request

Retorna uma unidade específica.

Security
BasicAuth
Path
idstringrequired

ID da unidade.

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

Responses

Unidade encontrado.

Bodyapplication/json
namestring

Nome da unidade.

Example: "Loja Matriz"
geofence_locationobject

Cerca virtual. Ponto lng/lat em conjunto com um raio define uma área onde é permitido o registro de ponto para funcionários vinculados à esta unidade.

timezonestring(TimezoneModel)

Fuso Horário utilizado para controle do horário de registro de ponto.

Enum"America/Araguaina""America/Bahia""America/Belem""America/Boa_Vista""America/Campo_Grande""America/Cuiaba""America/Eirunepe""America/Noronha""America/Fortaleza""America/Maceio"
Example: "America/Sao_Paulo"
employeesArray of arrays
Example: [["5f5bc225b511a6edec2891f7","0c5bc225b511a6edec289199"]]
Response
application/json
{
  "name": "Loja Matriz",
  "geofence_location": {
    "radius_meters": 30,
    "location": [ … ]
  },
  "timezone": "America/Sao_Paulo",
  "employees": [
    [ … ]
  ]
}

Atualiza uma unidade

Request

Atualiza uma unidade específica.

Security
BasicAuth
Path
idstringrequired

ID da unidade.

Headers
If-Matchstringrequired

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

Bodyapplication/json
namestring

Nome da unidade.

Example: "Loja Matriz"
geofence_locationobject

Cerca virtual. Ponto lng/lat em conjunto com um raio define uma área onde é permitido o registro de ponto para funcionários vinculados à esta unidade.

timezonestring(TimezoneModel)

Fuso Horário utilizado para controle do horário de registro de ponto.

Enum"America/Araguaina""America/Bahia""America/Belem""America/Boa_Vista""America/Campo_Grande""America/Cuiaba""America/Eirunepe""America/Noronha""America/Fortaleza""America/Maceio"
Example: "America/Sao_Paulo"
employeesArray of arrays
Example: [["5f5bc225b511a6edec2891f7","0c5bc225b511a6edec289199"]]
curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/sites/{id}' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: string' \
  -d '{
    "name": "Loja Matriz",
    "geofence_location": {
      "radius_meters": 30,
      "location": [
        -23.550513,
        -46.633309
      ]
    },
    "timezone": "America/Sao_Paulo",
    "employees": [
      [
        "5f5bc225b511a6edec2891f7",
        "0c5bc225b511a6edec289199"
      ]
    ]
  }'

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 uma unidade

Request

Security
BasicAuth
Path
idstringrequired

ID da unidade.

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

Responses

Cadastro excluído com sucesso.

Response
No content

Usuários

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

Operations