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
production
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

Adiciona um novo empregador

Request

Cria o novo empregador. Não é suportada a configuração de dados dos layouts de exportação através desta API.

Security
BasicAuth
Bodyapplication/json
namestring

Razão social do empregador.

Example: "TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."
cpfstring

CPF do empregador. Apenas números. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos.

Example: "01234567890"
cnpjstring

CNPJ do empregador. Apenas números. Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos.

Example: "23467093000164"
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 ("").

period_cut_dayinteger[ 1 .. 31 ]

Data de corte dos espelhos para este empregador. Depois de criado o documento, não é permitida a alteração deste valor através desta API.

addressobject
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/payment-sources \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "TIQUETAQUE SERVICOS DE TECNOLOGIA S.A.",
    "cpf": "01234567890",
    "cnpj": "23467093000164",
    "external_id": "string",
    "period_cut_day": 1,
    "address": {
      "cep": "90240111",
      "street_name": "RUA FREDERICO MENTZ",
      "street_number": "1606",
      "complement": "LOJA 134 E 135",
      "state": "RS",
      "city": "Porto Alegre"
    }
  }'

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 os empregadores

Request

Lista todos empregadores ativos 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/payment-sources?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
  }
}

Dados de um empregador

Request

Retorna um empregador pelo ID.

Security
BasicAuth
Path
idstringrequired

ID do empregador. Pode ser usado tanto _id quanto external_id

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

Responses

Empregador 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 strings

Lista de IDs de funcionários. Vincula os funcionários à esta unidade para todos efeitos.

Example: ["5f5bc225b511a6edec2891f7","0c5bc225b511a6edec289199"]
Response
application/json
{
  "name": "Loja Matriz",
  "geofence_location": {
    "name": "string",
    "radius_meters": 30,
    "location": [ … ]
  },
  "timezone": "America/Sao_Paulo",
  "employees": [
    "5f5bc225b511a6edec2891f7",
    "0c5bc225b511a6edec289199"
  ]
}

Atualiza um empregador

Request

Atualiza um empregador.

Security
BasicAuth
Path
idstringrequired

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 ("").

Headers
If-Matchstringrequired

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

Bodyapplication/json
namestring

Razão social do empregador.

cpfstring

CPF do empregador. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos.

cnpjstring

CNPJ do empregador. Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos.

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 ("").

addressobject
curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/payment-sources/{id}' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: string' \
  -d '{
    "name": "string",
    "cpf": "string",
    "cnpj": "string",
    "external_id": "string",
    "address": {
      "cep": 1307002,
      "street_name": "string",
      "street_number": "string",
      "complement": "string",
      "state": "SC",
      "city": "São Paulo"
    }
  }'

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 empregador

Request

Security
BasicAuth
Path
idstringrequired

ID do empregador. Pode ser usado tanto _id quanto external_id

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

Responses

Cadastro excluído com sucesso.

Response
No content

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