Para desenvolvedores

Construa sobre o Onplana

Leia e altere projetos e tarefas a partir do seu próprio código, saiba das mudanças assim que acontecem, leve o plano para os seus relatórios e deixe agentes de IA trabalharem nele. Cinco portas de entrada, cada uma com um token que age como a pessoa que o criou.

Cinco portas de entrada

Todas funcionam hoje. Comece pelo exemplo e depois siga o guia.

API REST com tokens de acesso pessoal

Crie um token em Configurações, depois Desenvolvedor, só com os escopos e projetos de que ele precisa e com uma data de expiração. Ele age como você, em uma organização, e nunca pode fazer mais do que você. A especificação OpenAPI 3.1 descreve cada rota.

Todos os planos, inclusive o gratuito

Suas tarefas em aberto, em todos os projetos
curl https://api.onplana.com/api/tasks/mine \
  -H "Authorization: Bearer pat_YOUR_TOKEN"

Webhooks assinados

O Onplana envia por POST uma carga JSON para a sua URL quando acontece um dos 22 tipos de evento. Cada entrega leva uma assinatura HMAC-SHA256 do corpo, feita com o seu segredo, e cada tentativa fica no histórico de entregas.

A partir do plano Business

Saber quando uma tarefa muda de status
curl -X POST https://api.onplana.com/api/webhooks \
  -H "Authorization: Bearer pat_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Status changes","url":"https://example.com/onplana","events":["task.status_changed"],"secret":"YOUR_SECRET"}'

O feed de relatórios OData

Um feed OData v4 somente leitura com projetos, tarefas, atribuições, recursos, linhas de planilhas de horas, valores de campos personalizados e linhas de base. Power BI, Excel ou o seu data warehouse entra com um token que tem o escopo de relatórios.

A partir do plano Professional

Ler cinco tarefas do feed
curl -u "token:pat_YOUR_TOKEN" \
  "https://api.onplana.com/api/odata/Tasks?$top=5"

Servidor MCP para agentes de IA

Claude, ChatGPT, Cursor e qualquer outro cliente MCP podem ler e gerenciar o trabalho com as permissões da pessoa que os conecta. Os clientes entram pelo navegador, então não é preciso registrar nenhum app antes.

Todos os planos, inclusive o gratuito. O número de agentes conectados ao mesmo tempo cresce com o plano.

Adicionar o Onplana a um cliente MCP
{
  "mcpServers": {
    "onplana": { "url": "https://mcp.onplana.com/mcp" }
  }
}

Conectores

Antes de construir, veja se a conexão já existe. Cada conector entra com um token de acesso pessoal e faz primeiro a mesma verificação.

  • Microsoft Teams e Microsoft 365 Copilot: disponíveis, em todos os planos, inclusive o gratuito.
  • Links para arquivos do SharePoint e do OneDrive nas tarefas: disponíveis, a partir do plano Professional.
  • Power Automate e Power Apps: o conector foi construído sobre a mesma API e ainda não está publicado.
  • Zapier: o app foi construído sobre a mesma API e ainda não está publicado.

Os gatilhos de um conector assinam um webhook: A partir do plano Business.

A verificação de conexão de um conector
curl https://api.onplana.com/api/organizations/current \
  -H "Authorization: Bearer pat_YOUR_TOKEN"

Como uma requisição funciona

  • Envie o token como token Bearer. Um token fica vinculado à organização em que foi criado, então a requisição não precisa de cabeçalho de organização.
  • Os erros voltam em JSON, com uma frase que pode ser exibida, um código e um requestId para citar quando escrever ao suporte.
  • Os limites são definidos por família de rotas. Uma requisição recusada responde 429 com um cabeçalho Retry-After em segundos: espere esse tempo e tente de novo.
  • A especificação está em api.onplana.com/api/openapi.json, então você pode gerar um cliente em qualquer linguagem a partir dela.

Qual plano cada porta precisa

Lido da tabela de preços, para que esta lista e a página de preços sempre concordem.

O que você usaPlano
API REST e tokens de acesso pessoalTodos os planos, inclusive o gratuito
WebhooksA partir do plano Business
Feed de relatórios ODataA partir do plano Professional
Servidor MCPTodos os planos, inclusive o gratuito
App do Microsoft Teams e agente do CopilotTodos os planos, inclusive o gratuito
Links para arquivos do SharePoint e do OneDriveA partir do plano Professional
Gatilhos de conectores (assinam um webhook)A partir do plano Business

O que os desenvolvedores perguntam

Existe um SDK?

Não. A API é JSON sobre HTTPS com uma especificação OpenAPI 3.1, então qualquer cliente HTTP funciona, e você pode gerar um cliente tipado a partir da especificação.

A API custa à parte?

Não. A API REST e os tokens estão em todos os planos, inclusive o gratuito. Os webhooks estão a partir do plano Business e o feed OData a partir do plano Professional.

Meu app de servidor pode agir por muitos clientes?

Ainda não por OAuth. Hoje cada cliente cria um token para a sua integração, e o token age como a pessoa que o criou. Se o seu produto precisa de mais, conte para nós o que é.

Onde estão os termos de uso da API?

A página de termos da API, na documentação para desenvolvedores, explica o uso aceitável, o que um token representa e como as mudanças incompatíveis são anunciadas.

Crie o seu primeiro token

Cadastre-se grátis, abra Configurações, depois Desenvolvedor, e crie um token com os escopos de que o seu código precisa.