Pular para o conteúdo principal

Introducao a Public API

A Public API da Copera e uma API REST que permite ler e gravar os dados do seu workspace de forma programatica — boards e linhas, documentos, arquivos do drive, channels, busca, notificacoes e metadados do workspace. Use-a para criar bots, automacoes, ferramentas internas e integracoes.

  • URL base: https://api.copera.ai/public/v1
  • Auth: Authorization: Bearer <token> (Personal Access Token, Integration API Key ou MCP OAuth token)
  • Formato: corpos de requisicao e resposta em JSON
dica

Chegou agora? Comece por Primeiros Passos para criar um token e fazer sua primeira requisicao, e depois passe os olhos em Autenticacao para escolher o tipo de token certo.

O Que Voce 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 comentarios
  • Buscar em linhas e dados de boards

Documentos​

Gerencie documentos com texto formatado:

  • Criar, atualizar e excluir documentos
  • Ler e gravar conteudo em Markdown
  • Buscar entre documentos
  • Navegar pela arvore 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:

  • Notificacoes e alertas
  • Respostas de bots
  • Atualizacoes de workflow
  • Ler e gerenciar suas proprias notificacoes

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 notificacoes a partir dos seus pipelines de CI/CD

Requisitos​

Para usar a API:

  1. Crie uma integracao (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 permissao — os escopos access_* relevantes para o que voce precisa (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Adicione a integracao aos channels e boards que ela precisa acessar. Um token so pode atuar nos recursos aos quais recebeu acesso.

Veja Autenticacao para o detalhamento completo dos tipos de token e escopos.

Proximos Passos​

  • Primeiros Passos — Crie um token e faca sua primeira requisicao
  • Autenticacao — Tipos de token, escopos e o header Bearer
  • Modo Desenvolvedor — Copie IDs de recursos direto da interface da Copera
  • Boards — Trabalhe com dados estruturados
  • Docs — Gerencie documentos
  • Drive — Armazenamento e gerenciamento de arquivos
  • Channels — Envie mensagens e notificacoes
  • Referencia da API — Explore cada endpoint, parametro e schema

Resumo​

Use a Public API da Copera para:

  • Ler e criar dados de boards, linhas e comentarios
  • Gerenciar documentos e arquivos do drive
  • Enviar mensagens e criar notificacoes
  • Buscar em todo o seu workspace
  • Criar integracoes personalizadas com o SDK, a CLI ou a GitHub Action