Aller au contenu principal

Vue d'ensemble de la Copera Public API : authentification et outils

La Copera Public API est une API REST qui vous permet de lire et d'écrire les données de votre workspace de façon programmatique — boards et lignes, documents, fichiers du drive, channels, search, notifications et métadonnées du workspace. Utilisez-la pour construire des bots, des automatisations, des outils internes et des intégrations. Vous pouvez aussi ajouter le widget web Omni à votre site et utiliser une clé d'API serveur liée à la source pour identifier les visiteurs connectés de façon sécurisée.

  • URL de base : https://api.copera.ai/public/v1
  • Auth : Authorization: Bearer <token> (Personal Access Token, Integration API Key, token MCP OAuth, ou la clé d'API serveur Omni liée à la source acceptée uniquement par l'endpoint de token d'identité)
  • Format : corps de requête et de réponse JSON
astuce

Nouveau ici ? Commencez par Premiers pas pour créer un token et faire votre première requête, puis parcourez Authentification pour choisir le bon type de token.

Ce que vous pouvez faire​

Boards​

Travaillez avec des données structurées :

  • Lister boards et tables
  • Récupérer les détails de boards et tables
  • Lire et créer des lignes
  • Authentifier des lignes et gérer les commentaires
  • Rechercher dans les lignes et les données de board

Documents​

Gérez des documents rich text :

  • Créer, mettre à jour et supprimer des documents
  • Lire et écrire le contenu en Markdown
  • Rechercher dans les documents
  • Naviguer dans les arbres de documents

Drive​

Stockage et gestion de fichiers :

  • Parcourir fichiers et dossiers
  • Envoyer et télécharger des fichiers
  • Créer des dossiers
  • Rechercher dans les éléments du drive

Messagerie​

Envoyez des messages formatés aux channels du workspace pour :

  • Notifications et alertes
  • Réponses de bots
  • Mises à jour de workflows
  • Lire et gérer vos propres notifications

Outils et SDK​

Node.js SDK
SDK TypeScript complet avec couverture API totale
CLI
Gérez boards, docs, drive et messagerie depuis le terminal
GitHub Action
Envoyez des notifications depuis vos pipelines CI/CD

Prérequis​

Pour utiliser l'API :

  1. Créez une intégration (ou un Personal Access Token) dans votre workspace.
  2. Générez un token — une Integration API Key (cp_key_…) ou un Personal Access Token (cp_pat_…).
  3. Accordez les scopes de permission — les scopes access_* pertinents pour ce dont vous avez besoin (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Ajoutez l'intégration aux channels et boards qu'elle doit atteindre. Un token ne peut agir que sur les ressources auxquelles l'accès lui a été accordé.

Voir Authentification pour le détail complet des types de tokens et des scopes.

Prochaines étapes​

Résumé​

Utilisez la Copera Public API pour :

  • Lire et créer des données de board, des lignes et des commentaires
  • Gérer des documents et des fichiers du drive
  • Envoyer des messages et créer des notifications
  • Rechercher dans votre workspace
  • Construire des intégrations personnalisées avec le SDK, la CLI ou la GitHub Action