Skip to content
ver .md original

Início rápido da API de Plan

Faça suas primeiras chamadas à API do Dailybot Plan em menos de cinco minutos: obtenha um token, liste seus quadros, crie uma tarefa, mova-a e comente nela, com curl e a CLI.

Beta

Plan está em beta. Tudo o que está em /plan no aplicativo web, os comandos da CLI e da agent skill para projetos, metas, quadros e tarefas, e a API pública /v1/plan/ podem mudar antes da disponibilidade geral. Quer testar com sua equipe? Escreva para [email protected].

solicitar acesso à beta

Em cerca de cinco minutos você vai fazer login, encontrar um quadro, criar uma tarefa, movê-la para “em andamento” e deixar um comentário nela. Cada passo mostra a chamada com curl e o equivalente na CLI do Dailybot.

Você precisa de curl e jq (para ler JSON no terminal), e de um e-mail que pertença a uma organização do Dailybot com a Beta do Plan habilitada.

1. Obtenha um token

A credencial mais rápida é um token de usuário da CLI: ele age como você, com o seu papel. Peça um código de uso único por e-mail:

curl -sS -X POST "https://api.dailybot.com/v1/cli/auth/request-code/" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

Cole o código do e-mail no lugar de 123456 e guarde o token em DAILYBOT_TOKEN:

export DAILYBOT_TOKEN=$(curl -sS -X POST "https://api.dailybot.com/v1/cli/auth/verify-code/" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "code": "123456"}' | jq -r .access_token)

Se o seu e-mail pertence a várias organizações, a primeira chamada responde "status": "select_organization" com uma lista: envie de novo com "organization_uuid" definido para a que você quer.

Na CLI, dailybot login executa o mesmo fluxo de código por e-mail e guarda a sessão para você:

dailybot login

Uma API key pessoal também funciona (X-API-KEY: $DAILYBOT_API_KEY) e age como você, sem scope a solicitar. Uma key de agente ou da organização age como um ator do sistema, precisa ter os scopes do Plan habilitados (durante o Beta, escreva para [email protected]) e é recusada nos endpoints que exigem uma pessoa. Veja Autenticação do Plan.

2. Confirme que o Plan está habilitado

curl -sS "https://api.dailybot.com/v1/plan/entitlements/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN"

O que você procura é "enabled": true. Se receber "enabled": false, ou se qualquer outra chamada do Plan responder 402 plan_upgrade_required, isso é esperado: sua organização ainda não está na Beta. Escreva para [email protected] e nós a habilitamos.

3. Liste seus quadros

curl -sS "https://api.dailybot.com/v1/plan/boards/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" | jq '.results[] | {uuid, key, name}'

Guarde o uuid do primeiro quadro para os próximos passos:

export BOARD=$(curl -sS "https://api.dailybot.com/v1/plan/boards/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" | jq -r '.results[0].uuid')

Na CLI:

dailybot plan board list --json

4. Crie uma tarefa

board e title são obrigatórios. O header Idempotency-Key torna a chamada segura para repetir: enviá-la de novo com a mesma chave e o mesmo corpo devolve a primeira tarefa em vez de criar uma segunda.

export TASK=$(curl -sS -X POST "https://api.dailybot.com/v1/plan/tasks/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-$(date +%s)" \
  -d "{\"board\": \"$BOARD\", \"title\": \"My first task from the API\"}" | jq -r .key)
echo "$TASK"

Agora TASK guarda a chave da tarefa, como ENG-143. Você pode usá-la em qualquer lugar onde uma tarefa é referenciada.

Na CLI:

dailybot plan task create -t "My first task from the API" -b "$BOARD"

5. Mova-a para "em andamento"

As colunas de um quadro são seus estados do fluxo de trabalho. Encontre o primeiro estado cuja categoria é in_progress e mova a tarefa para ele:

export STATE=$(curl -sS "https://api.dailybot.com/v1/plan/boards/$BOARD/states/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" | jq -r '[.[] | select(.category == "in_progress")][0].uuid')

curl -sS -X POST "https://api.dailybot.com/v1/plan/tasks/$TASK/move/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"state\": \"$STATE\"}" | jq '{key, state: .state.name, version}'

Sem after nem before, a tarefa vai para o fim da coluna. Mover a tarefa é a única forma de mudar o estado dela.

Na CLI:

dailybot plan task move "$TASK" --state in_progress

6. Comente nela

curl -sS -X POST "https://api.dailybot.com/v1/plan/tasks/$TASK/comments/" \
  -H "Authorization: Bearer $DAILYBOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body": "Created and moved from the Plan API quickstart."}' | jq '{uuid, body, created_at}'

Na CLI:

dailybot plan task comment "$TASK" "Created and moved from the Plan API quickstart."

Esse é o ciclo completo: você leu um quadro, criou uma tarefa, mudou o estado dela e comentou nela.

Estes comandos da CLI chegam na próxima versão da CLI do Dailybot. Adicione --json a qualquer um deles para obter uma saída legível por máquina.

Próximos passos