Saltar al contenido principal

Introducción a la Public API

La Public API de Copera es una API REST que te permite leer y escribir los datos de tu Workspace de forma programática — boards y filas, documentos, archivos de drive, channels, search, notifications y metadatos del Workspace. Úsala para crear bots, automatizaciones, herramientas internas e integraciones.

  • URL base: https://api.copera.ai/public/v1
  • Auth: Authorization: Bearer <token> (Personal Access Token, Integration API Key o token OAuth de MCP)
  • Formato: cuerpos de solicitud y respuesta en JSON
consejo

¿Eres nuevo aquí? Empieza por Primeros pasos para crear un token y hacer tu primera solicitud, y luego repasa Autenticación para elegir el tipo de token correcto.

Qué puedes hacer​

Boards​

Trabaja con datos estructurados:

  • Listar boards y tablas
  • Obtener detalles de board y tabla
  • Leer y crear filas
  • Autenticar filas y gestionar comentarios
  • Buscar entre filas y datos de board

Documentos​

Gestiona documentos de texto enriquecido:

  • Crear, actualizar y eliminar documentos
  • Leer y escribir contenido como Markdown
  • Buscar entre documentos
  • Navegar por árboles de documentos

Drive​

Almacenamiento y gestión de archivos:

  • Explorar archivos y carpetas
  • Subir y descargar archivos
  • Crear carpetas
  • Buscar entre los elementos de drive

Mensajería​

Envía mensajes con formato a los channels del Workspace para:

  • Notificaciones y alertas
  • Respuestas de bots
  • Actualizaciones de flujos de trabajo
  • Leer y gestionar tus propias notificaciones

Herramientas y SDKs​

Node.js SDK
SDK de TypeScript con todas las funciones y cobertura completa de la API
CLI
Gestiona boards, docs, drive y mensajería desde la terminal
GitHub Action
Envía notificaciones desde tus pipelines de CI/CD

Requisitos​

Para usar la API:

  1. Crea una integración (o un Personal Access Token) en tu Workspace.
  2. Genera un token — una Integration API Key (cp_key_…) o un Personal Access Token (cp_pat_…).
  3. Otorga scopes de permiso — los scopes access_* correspondientes a lo que necesitas (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Agrega la integración a los channels y boards que necesita alcanzar. Un token solo puede actuar sobre los recursos a los que se le ha otorgado acceso.

Consulta Autenticación para el desglose completo de los tipos de token y scopes.

Próximos pasos​

  • Primeros pasos — Crea un token y haz tu primera solicitud
  • Autenticación — Tipos de token, scopes y el encabezado Bearer
  • Modo desarrollador — Copia los IDs de recursos directamente desde la interfaz de Copera
  • Boards — Trabaja con datos estructurados
  • Docs — Gestiona documentos
  • Drive — Almacenamiento y gestión de archivos
  • Channels — Envía mensajes y notificaciones
  • Referencia de la API — Explora cada endpoint, parámetro y esquema

Resumen​

Usa la Public API de Copera para:

  • Leer y crear datos de board, filas y comentarios
  • Gestionar documentos y archivos de drive
  • Enviar mensajes y crear notificaciones
  • Buscar en todo tu Workspace
  • Construir integraciones personalizadas con el SDK, el CLI o la GitHub Action