Premiers pas

Ce guide vous emmène de zéro à votre première requête authentifiée : créez un token, définissez l'URL de base, et appelez l'API.

Prérequis

• Accès à un workspace éligible à la Public API.
• Permission de créer des tokens dans ce workspace.
• Une familiarité de base avec les ressources Copera — boards, tables, lignes, channels, documents.

Étape 1 — Créer un Personal Access Token

Un Personal Access Token (PAT, préfixe cp_pat_) authentifie l'API en tant que vous et débloque toute la surface de l'API. C'est le moyen le plus simple de commencer.

Ouvrir les paramètres du workspace

Allez dans Workspace Settings → Integrations.

Ouvrir l'onglet Personal Tokens

Sélectionnez Personal Tokens, puis Create new token.

Le nommer, le scopper, définir l'expiration

Donnez un nom au token, sélectionnez les scopes dont il a besoin, et définissez une date d'expiration (jusqu'à 1 an).

Copier le token maintenant

Le token n'est affiché qu'une seule fois. Copiez-le immédiatement et stockez-le dans un gestionnaire de secrets ou une variable d'environnement.

avertissement

Traitez les tokens comme des mots de passe. Ne les versionnez jamais dans le contrôle de source. Si un token fuit, supprimez-le et créez-en un nouveau.

Pour le détail complet des types de tokens et des scopes, voir Authentification.

Étape 2 — Définir l'URL de base

Tous les endpoints se trouvent sous :

https://api.copera.ai/public/v1

Chaque requête doit inclure votre token dans l'en-tête Authorization avec le schéma Bearer :

Authorization: Bearer cp_pat_your_token_here

Étape 3 — Faire votre première requête

Ceci liste les boards auxquels votre token peut accéder.

curl

curl https://api.copera.ai/public/v1/board/list-boards \
  -H "Authorization: Bearer cp_pat_your_token_here"

JavaScript

const res = await fetch(
  "https://api.copera.ai/public/v1/board/list-boards",
  {
    headers: {
      Authorization: "Bearer cp_pat_your_token_here",
    },
  },
);

if (!res.ok) {
  const error = await res.json();
  throw new Error(`${res.status}: ${error.message}`);
}

const boards = await res.json();
console.log(boards);

Une réponse 200 renvoie du JSON. Un 401 signifie que le token est manquant, mal formé ou expiré — voir Authentification. Les autres échecs suivent le schéma d'erreur partagé.

Étape 4 — Envoyer un message (optionnel)

Si votre token a le scope access_channels, vous pouvez poster dans un channel :

curl -X POST \
  https://api.copera.ai/public/v1/chat/channel/{channelId}/send-message \
  -H "Authorization: Bearer cp_pat_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Hello from my integration!" }'

astuce

Activez le Mode développeur pour copier les IDs de ressources (channel, board, table, colonne) directement depuis l'interface Copera — sans inspection réseau.

Prochaines étapes

• Authentification — types de tokens, scopes et sécurité.
• Pagination — comment les endpoints de liste paginent les résultats.
• Gestion des erreurs — codes de statut et récupération.
• Limites de débit — limites par endpoint et backoff.
• Référence de l'API — chaque endpoint et schéma.