Pular para o conteúdo principal

Introdução à Public API

A Public API da Copera é uma API REST que permite ler e gravar os dados do seu workspace de forma programática — boards e linhas, documentos, arquivos do drive, channels, busca, notificações e metadados do workspace. Use-a para criar bots, automações, ferramentas internas e integrações. Você também pode adicionar o widget web do Omni ao seu site e usar uma chave de API do servidor vinculada à fonte para identificar visitantes autenticados com segurança.

  • URL base: https://api.copera.ai/public/v1
  • Auth: Authorization: Bearer <token> (Personal Access Token, Integration API Key, MCP OAuth token ou a chave do servidor Omni vinculada à fonte, aceita somente pelo endpoint de token de identidade)
  • Formato: corpos de requisição e resposta em JSON
dica

Está começando agora? Acesse Primeiros Passos para criar um token e fazer sua primeira requisição. Depois, consulte Autenticação para escolher o tipo de token certo.

O Que Você Pode Fazer​

Boards​

Trabalhe com dados estruturados:

  • Listar boards e tabelas
  • Obter detalhes de boards e tabelas
  • Ler e criar linhas
  • Autenticar linhas e gerenciar comentários
  • Buscar em linhas e dados de boards

Documentos​

Gerencie documentos com texto formatado:

  • Criar, atualizar e excluir documentos
  • Ler e gravar conteúdo em Markdown
  • Buscar entre documentos
  • Navegar pela árvore de documentos

Drive​

Armazenamento e gerenciamento de arquivos:

  • Navegar por arquivos e pastas
  • Fazer upload e download de arquivos
  • Criar pastas
  • Buscar entre itens do drive

Mensagens​

Envie mensagens formatadas para channels do workspace para:

  • Notificações e alertas
  • Respostas de bots
  • Atualizações de workflow
  • Ler e gerenciar suas próprias notificações

Ferramentas e SDKs​

Node.js SDK
SDK completo em TypeScript com cobertura total da API
CLI
Gerencie boards, docs, drive e mensagens pelo terminal
GitHub Action
Envie notificações a partir dos seus pipelines de CI/CD

Requisitos​

Para usar a API:

  1. Crie uma integração (ou um Personal Access Token) no seu workspace.
  2. Gere um token — uma Integration API Key (cp_key_…) ou um Personal Access Token (cp_pat_…).
  3. Conceda escopos de permissão — os escopos access_* relevantes para o que você precisa (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Adicione a integração aos channels e boards que ela precisa acessar. Um token só pode atuar nos recursos aos quais recebeu acesso.

Veja Autenticação para o detalhamento completo dos tipos de token e escopos.

Próximos Passos​

Resumo​

Use a Public API da Copera para:

  • Ler e criar dados de boards, linhas e comentários
  • Gerenciar documentos e arquivos do drive
  • Enviar mensagens e criar notificações
  • Buscar em todo o seu workspace
  • Criar integrações personalizadas com o SDK, a CLI ou a GitHub Action