Introdução

A API Pública da TakeFlow é uma API REST somente leitura (todos os endpoints são GET) que devolve, em JSON, os indicadores de atendimento da empresa dona da chave.

URL base

https://api.takeflow.com.br

Todas as rotas começam com /public/v1/. A referência interativa (Swagger) fica em /docs na mesma URL.

Convenções

1. A empresa vem da chave. Não existe parâmetro de empresa: os dados devolvidos são sempre os da empresa dona da chave. Enviar companyId (ou qualquer parâmetro que o endpoint não conhece) devolve 400.
2. Parâmetros inválidos devolvem 400. Data fora do formato, id que não é número inteiro, UUID inválido, limit fora de 1 a 200, page fora de 1 a 10000: nada é ignorado em silêncio. Veja Tratamento de erros.
3. Período sempre fechado, no fuso da empresa. initialDate e finalDate são dias no formato YYYY-MM-DD e contam do início do dia inicial ao fim do dia final no fuso configurado na empresa (padrão America/Sao_Paulo).
   • Sem nenhuma data: últimos 30 dias até hoje.
   • Só initialDate: 30 dias a partir dela.
   • Só finalDate: 30 dias até ela.
   • Período máximo: 31 dias em /reports/tickets/detailed e 366 dias nos demais relatórios. Acima disso, 400 com code: PERIOD_TOO_LONG.
4. Ids separados por vírgula. Os filtros queueIds, userIds, whatsappIds e tagIds aceitam um ou mais ids inteiros: queueIds=1,2. Em tagIds, o ticket precisa ter todas as tags informadas.
5. Tempos em minutos. Todo campo de tempo termina em Minutes e segue o cálculo do Dashboard da TakeFlow.
6. Relatórios que devolvem o período incluem o objeto period com as datas efetivamente usadas, útil quando você não enviou datas.

Próximos passos

• Autenticação: como gerar e enviar a chave.
• Limites de requisições.
• Tratamento de erros.
• Exemplos de integração.