API Pública do TaskRush: como integrar e personalizar sua operação

Se a sua empresa precisa conectar sistemas, automatizar processos ou adaptar o TaskRush ao seu fluxo interno, a API Pública do TaskRush permite desenvolver integrações personalizadas.

Com ela, você pode conectar o TaskRush a ERPs, CRMs, sites, aplicativos próprios, ferramentas de BI e outros sistemas utilizados no dia a dia, facilitando a troca de informações e a automação de atividades.

Neste tutorial, você vai aprender como acessar a API Pública, criar tokens de autenticação, configurar permissões, consultar a documentação Swagger e conhecer os recursos disponíveis para integração.

O que é a API Pública do TaskRush?

A API Pública permite utilizar endpoints oficiais do TaskRush para consultar, criar, editar e integrar informações da plataforma com outros sistemas.

Isso significa mais liberdade para desenvolver processos personalizados, sem depender apenas das integrações prontas.

A API utiliza autenticação por token e respeita as permissões do usuário responsável por sua criação. As informações acessadas também ficam restritas à empresa vinculada ao token.

O que é possível integrar?

A API Pública do TaskRush permite realizar operações relacionadas a diferentes recursos da plataforma:

• Clientes: consultar, cadastrar, atualizar e excluir clientes;

• Projetos: consultar, criar, editar e excluir projetos;

• Tarefas: consultar, criar, atualizar e excluir tarefas;

• Times: gerenciar times e suas informações;

• Usuários: consultar e administrar usuários;

• Tempo: iniciar e pausar cronômetros, registrar horas manualmente e consultar lançamentos;

• Webhooks: configurar assinaturas para receber notificações de eventos da plataforma.

Esses recursos permitem desenvolver integrações personalizadas, como cadastrar clientes automaticamente a partir de formulários, criar projetos por sistemas externos, sincronizar tarefas, automatizar registros de tempo e conectar o TaskRush a outras ferramentas utilizadas pela empresa.

As operações disponíveis dependem das permissões configuradas para cada token e do perfil do usuário responsável.

Veja como acessar a API Pública

A área de gerenciamento da API Pública está disponível para administradores e gestores do TaskRush.

Para acessar e criar um token, siga o passo a passo:

1. Acesse sua conta no TaskRush;

2. Clique no ícone de engrenagem para abrir as configurações;

3. Acesse a seção Desenvolvedores → API;

4. Na área Tokens da API pública, clique em Criar token;

5. Informe um nome para identificar a integração;

6. Selecione os escopos de acesso que o token terá;

7. Se desejar, defina uma data de expiração;

8. Clique em Criar token para concluir;

9. Copie o token gerado e armazene-o em um local seguro;

10. Clique em Abrir Swagger para consultar a documentação e testar os endpoints disponíveis.

Importante: o token completo é exibido apenas uma vez, logo após sua criação. Caso perca essa informação, será necessário revogar o token e criar outro.

Como configurar as permissões do token?

Ao criar um token da API Pública, você pode definir quais operações a integração terá permissão para executar.

Essas permissões são chamadas de escopos e ajudam a limitar o acesso aos recursos necessários para cada integração.

Os escopos disponíveis incluem:

• Tarefas: leitura ou criação, edição e exclusão;

• Projetos: leitura ou criação e edição. A exclusão também exige perfil de administrador ou gestor;

• Clientes, times e usuários: leitura ou gerenciamento dos registros;

• Tempo: consulta aos lançamentos de horas, registro de tempo e controle do cronômetro;

• Webhooks: leitura ou gerenciamento das assinaturas de webhook.

As operações de escrita relacionadas a clientes, times, usuários e webhooks exigem que o usuário responsável pelo token tenha perfil de administrador ou gestor.

O ideal é selecionar apenas as permissões necessárias para o funcionamento de cada integração.

Como definir a validade do token?

Durante a criação, você também pode configurar uma data de expiração.

Esse campo é opcional. Se não for preenchido, o token não terá uma data de expiração definida.

Para maior segurança, recomenda-se conceder apenas as permissões necessárias para cada integração e armazenar o token em um ambiente protegido.

Se um token for perdido ou comprometido, revogue-o e crie outro.

Como funciona a autenticação da API?

A API Pública utiliza tokens para autenticar as requisições feitas por sistemas externos.

O método recomendado é enviar o token no cabeçalho da requisição, utilizando o formato:

Authorization: Bearer SEU_TOKEN

A API também aceita o cabeçalho alternativo X-Public-Api-Token.

Cada token atua em nome do usuário que o criou, respeitando as permissões configuradas e seu perfil de acesso.

Por segurança, não compartilhe seus tokens nem os exponha em códigos públicos.

Documentação completa no Swagger

Ao clicar no botão Abrir Swagger, você acessa a documentação interativa da API Pública do TaskRush.

Nesse ambiente, é possível consultar os endpoints disponíveis, verificar os parâmetros necessários e realizar testes diretamente pelo navegador.

Para testar uma operação:

1. Acesse o Swagger pelo botão disponível na área da API;

2. Clique em Authorize;

3. Informe o token gerado no TaskRush e confirme a autorização;

4. Selecione o endpoint que deseja utilizar;

5. Consulte os parâmetros necessários;

6. Utilize a opção Try it out para preencher os dados;

7. Clique em Execute para realizar a requisição e visualizar a resposta.

As operações disponíveis dependem dos escopos configurados para o token e das permissões do usuário responsável.

Quais módulos estão disponíveis no Swagger?

A documentação está organizada em módulos para facilitar a consulta aos endpoints.

As seções disponíveis são:

• Clients: gerenciamento de clientes;

• Projects: criação, consulta e gerenciamento de projetos;

• Tasks: operações relacionadas às tarefas;

• Teams: gerenciamento de times;

• Users: consulta e administração de usuários;

• Me: consulta às informações do usuário associado ao token;

• Time: controle de cronômetros e registros de horas;

• Webhooks: gerenciamento de assinaturas de webhook;

• Schemas: estruturas de dados utilizadas nas requisições e respostas.

Cada módulo apresenta os endpoints disponíveis e os métodos utilizados nas operações:

• GET: consultar informações;

• POST: criar registros ou executar ações;

• PUT: atualizar informações;

• DELETE: excluir registros.

Existem limites de utilização da API?

Sim. A API Pública do TaskRush possui um limite de 120 requisições por minuto por token e também por endereço IP.

Quando esse limite é ultrapassado, a API retorna o código HTTP 429, indicando que é necessário aguardar antes de realizar novas requisições.

As consultas que retornam listas também utilizam paginação para organizar os resultados.

Por padrão, são exibidos 15 registros por página, sendo possível configurar até 100 registros por página.

Esses controles ajudam a organizar as consultas e o consumo dos recursos da API.

Como utilizar a API para registrar horas?

O módulo Time permite integrar o acompanhamento de horas do TaskRush a sistemas externos.

Entre as operações disponíveis estão:

• iniciar o cronômetro de uma tarefa;

• pausar o cronômetro;

• registrar horas manualmente;

• consultar o cronômetro ativo do usuário;

• consultar lançamentos de horas em determinado período.

Esses endpoints podem ser utilizados em integrações que precisam automatizar registros de tempo ou consultar informações sobre as horas dedicadas às atividades.

Como funcionam os Webhooks?

Os webhooks permitem configurar assinaturas para receber notificações de eventos da plataforma em sistemas externos.

Pela API, é possível:

• listar assinaturas de webhook;

• criar assinaturas;

• consultar uma assinatura pelo identificador;

• atualizar uma assinatura;

• remover uma assinatura.

Esse recurso pode ser utilizado para desenvolver integrações que precisam reagir a eventos do TaskRush sem depender exclusivamente de consultas periódicas à API.

Os eventos disponíveis e os dados enviados devem ser consultados na documentação do Swagger.

Quais eventos podem ser acompanhados pelos Webhooks?

Os webhooks permitem receber notificações relacionadas a quatro eventos:

• task.created: quando uma tarefa é criada;

• task.status_changed: quando o status de uma tarefa é alterado;

• time.started: quando um cronômetro é iniciado;

• time.stopped: quando um cronômetro é pausado.

Para configurar o recebimento, é necessário cadastrar uma URL HTTPS e selecionar os eventos desejados.

As notificações possuem assinatura de segurança HMAC-SHA256, que permite verificar a autenticidade das informações recebidas.

Posso integrar os Webhooks com n8n e Zapier?

Sim. É possível utilizar os webhooks do TaskRush em fluxos desenvolvidos no n8n ou no Zapier.

Embora não exista um conector nativo específico, essas ferramentas permitem receber eventos por webhook e utilizá-los para iniciar automações.

Para isso, configure um endpoint de recebimento na ferramenta escolhida e cadastre a URL correspondente na API Pública do TaskRush.

Benefícios da API TaskRush

Ao utilizar a API Pública, sua empresa pode obter benefícios como:

• Flexibilidade operacional: integração com sistemas e processos internos;

• Automação de atividades: redução de tarefas manuais e repetitivas;

• Centralização das informações: conexão entre dados de diferentes ferramentas;

• Integrações personalizadas: desenvolvimento de fluxos conforme as necessidades da empresa;

• Controle de acesso: utilização de tokens com permissões específicas;

• Escalabilidade: possibilidade de ampliar as integrações conforme a operação cresce;

• Ganho de produtividade: automatização da troca de informações e de atividades operacionais.

Quando usar a API?

A API é indicada para empresas que desejam:

• conectar o TaskRush a sistemas de CRM;

• enviar informações para dashboards e ferramentas de BI;

• integrar sistemas financeiros e projetos;

• automatizar o cadastro e o onboarding de clientes;

• sincronizar tarefas entre diferentes plataformas;

• controlar cronômetros e consultar horas por sistemas externos;

• criar fluxos automatizados com webhooks;

• desenvolver ferramentas internas personalizadas.

A escolha dos endpoints e das permissões deve considerar os objetivos de cada integração e os recursos necessários para seu funcionamento.

Use agora mesmo

Se sua empresa precisa integrar sistemas, automatizar processos ou criar fluxos personalizados, a API Pública do TaskRush pode fazer parte da sua operação.

Com ela, você conecta o TaskRush a outras ferramentas utilizadas no dia a dia e ganha mais flexibilidade para construir processos organizados e integrados.

Precisa de apoio técnico?

Se sua equipe precisa entender melhor como aplicar a API no negócio, entre em contato com o suporte pelo e-mail suporte@taskrush.com.br para receber orientações sobre uso e boas práticas.