Zum Hauptinhalt springen

Copera Public API Übersicht: Authentifizierung und Tools

Die Copera Public API ist eine REST-API, mit der Sie Ihre Workspace-Daten programmatisch lesen und schreiben — Boards und Zeilen, Dokumente, Drive-Dateien, Channels, Suche, Benachrichtigungen und Workspace-Metadaten. Nutzen Sie sie für Bots, Automatisierungen, interne Tools und Integrationen. Sie können auch das Omni-Web-Widget auf Ihrer Website einbinden und mit einem quellengebundenen Server-API-Key angemeldete Besucher sicher identifizieren.

  • Basis-URL: https://api.copera.ai/public/v1
  • Auth: Authorization: Bearer <token> (Personal Access Token, Integration API Key, MCP-OAuth-Token oder der quellengebundene Omni-Server-API-Key, der nur vom Identity-Token-Endpunkt akzeptiert wird)
  • Format: JSON-Request- und Response-Bodies
tipp

Neu hier? Beginnen Sie mit Erste Schritte, um ein Token zu erstellen und Ihre erste Anfrage zu senden. Lesen Sie danach Authentifizierung, um den richtigen Token-Typ zu wählen.

Was Sie tun können​

Boards​

Mit strukturierten Daten arbeiten:

  • Boards und Tabellen auflisten
  • Board- und Tabellen-Details abrufen
  • Zeilen lesen und anlegen
  • Zeilen authentifizieren und Kommentare verwalten
  • Über Zeilen und Board-Daten suchen

Dokumente​

Rich-Text-Dokumente verwalten:

  • Dokumente anlegen, aktualisieren und löschen
  • Inhalt als Markdown lesen und schreiben
  • Über Dokumente suchen
  • Dokumentenbäume navigieren

Drive​

Dateispeicher und -verwaltung:

  • Dateien und Ordner durchsuchen
  • Dateien hoch- und herunterladen
  • Ordner anlegen
  • Über Drive-Einträge suchen

Messaging​

Formatierte Nachrichten an Workspace-Channels senden für:

  • Benachrichtigungen und Alerts
  • Bot-Antworten
  • Workflow-Updates
  • Eigene Benachrichtigungen lesen und verwalten

Tools & SDKs​

Node.js SDK
Vollständiges TypeScript-SDK mit kompletter API-Abdeckung
CLI
Boards, Docs, Drive und Messaging vom Terminal aus verwalten
GitHub Action
Benachrichtigungen aus CI/CD-Pipelines senden

Voraussetzungen​

Um die API zu nutzen:

  1. Eine Integration anlegen (oder ein Personal Access Token) in Ihrem Workspace.
  2. Ein Token erzeugen — einen Integration API Key (cp_key_…) oder ein Personal Access Token (cp_pat_…).
  3. Berechtigungs-Scopes vergeben — die passenden access_*-Scopes für Ihren Bedarf (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Die Integration den Channels und Boards hinzufügen, die sie erreichen soll. Ein Token kann nur auf Ressourcen wirken, für die Zugriff gewährt wurde.

Siehe Authentifizierung für die vollständige Aufschlüsselung der Token-Typen und Scopes.

Nächste Schritte​

Zusammenfassung​

Mit der Copera Public API können Sie:

  • Board-Daten, Zeilen und Kommentare lesen und anlegen
  • Dokumente und Drive-Dateien verwalten
  • Nachrichten senden und Benachrichtigungen erzeugen
  • Über Ihren Workspace suchen
  • Eigene Integrationen mit SDK, CLI oder GitHub Action bauen