Getting Started

Authentification

Clés API, scopes, environnements test et live.

Toutes les requêtes à l'API REST doivent inclure un header `Authorization` avec un Bearer token. Aucun cookie, aucune session.

Format du header

Authorization: Bearer cof_live_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Environnements

Chaque workspace dispose de deux familles de clés :

**`cof_live_sk_...`** - Production. Crée de vrais transferts, déclenche de vraies webhooks, compte dans vos quotas.
**`cof_test_sk_...`** - Sandbox. Aucune donnée réelle stockée. Quotas illimités. Idéal pour CI/CD et staging.

Ne jamais exposer une clé live

Stockez vos clés dans des variables d'environnement (`COFFRIFY_API_KEY`). Ne les committez pas dans votre dépôt Git, ne les exposez pas côté navigateur.

Scopes disponibles

**`transfers:read`** - Lister et consulter les transferts
**`transfers:write`** - Créer, mettre à jour et supprimer des transferts
**`webhooks:manage`** - Créer, modifier et supprimer des abonnements webhook
**`api_keys:read`** - Lister les clés API du workspace
**`workspace:read`** - Lire les informations et paramètres du workspace

Créer une clé avec scopes réduits

create-api-key.tstypescript

const key = await client.apiKeys.create({
  name: 'CI/CD - upload only',
  scopes: ['transfers:write'],
  expires_at: '2027-06-01', // ISO 8601, optionnel
});

// Le secret est visible UNE SEULE FOIS à la création
console.log(key.secret); // "cof_live_sk_..."

Réponse 401 - clé invalide ou expirée

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key.",
    "doc_url": "https://docs.coffrify.com/authentication"
  }
}

Révoquer une clé

Dashboard → **API Keys** → **Révoquer**. La révocation est instantanée - la clé est invalide immédiatement. Créez une nouvelle clé et mettez à jour vos variables d'environnement. Les transferts existants ne sont pas affectés.