LBHM Tasks

API — Visão geral

O LBHM Tasks expõe uma API HTTP (JSON) para que outros sistemas criem e consultem tarefas automaticamente. O uso típico é enviar tarefas geradas por um sistema (uma pendência, uma exceção, uma solicitação) para que a equipe certa as receba e acompanhe.

Endereço base

Todas as rotas ficam sob o prefixo /api/v1 no endereço da sua organização:

https://suaorganizacao.tasks.lbhm.com.br/api/v1

O endereço exato é informado pela LBHM.

Autenticação

A API usa um token enviado no cabeçalho Authorization:

Authorization: Bearer SEU_TOKEN

Se o sistema de origem não permitir montar o cabeçalho Authorization, envie o mesmo valor em X-Api-Token:

X-Api-Token: SEU_TOKEN

Os tokens ficam em Tokens de API, no menu lateral: cada um tem um nome e pode ser revogado quando você quiser — ao revogar, as chamadas que usam aquele token param de ser aceitas na hora. O valor completo aparece uma única vez, no momento em que o token é gerado; copie-o ali. Trate-o como um segredo: ele dá acesso à API da sua organização. Requisições sem token válido recebem 401 Unauthorized.

Formato

  • Corpo das requisições e respostas em JSON (Content-Type: application/json).
  • Datas em texto no formato AAAA-MM-DD HH:MM:SS (horário de Brasília) ou ISO 8601.
  • Códigos de resposta seguem o padrão HTTP: 200/201 em sucesso, 401 sem autenticação, 422 quando faltam campos obrigatórios, 404 quando o recurso não existe. Cada recusa e o que fazer com ela estão em Erros e respostas da API.

Valores de referência

  • Status de tarefa: aberta, em_andamento, bloqueada, concluida, cancelada, resolvido, nao_se_aplica.
  • Prioridade: baixa, media, alta, urgente.

Quatro desses status — concluida, cancelada, resolvido e nao_se_aplica — encerram a tarefa. Ao aplicar um deles pela API, envie também o campo motivo com a explicação do desfecho; sem ele a requisição volta com 422 e a tarefa permanece como está.

Idempotência

Ao enviar tarefas, informe um par origem + referencia_externa (veja Tarefas). Reenviar a mesma combinação atualiza a tarefa existente em vez de criar uma duplicada — útil para reentregas e reprocessamentos seguros.

Próximas páginas