Gérer vos environnements staging et production

L'API Coffrify distingue trois environnements : live (production), test (staging, données isolées) et sandbox (clés éphémères à 24 h, idéales pour les démos). Chaque clé API porte son environnement directement dans son préfixe, ce qui rend impossible toute confusion entre un appel de test et un appel de production. Cet article explique comment vérifier votre contexte courant, lister vos workspaces accessibles et mettre en place une stratégie robuste d'isolation CI/CD.

Endpoints concernés

Deux endpoints suffisent à vérifier votre contexte d'exécution : GET /v1/me pour la clé courante et GET /v1/workspaces pour les espaces accessibles.

Authentification

Ces deux endpoints ne requièrent aucun scope particulier : une clé valide suffit. La clé doit être transmise dans l'en-tête Authorization: Bearer <clé>. L'environnement est déduit automatiquement du préfixe de la clé : - cof_live_… correspond à l'environnement live (production) - cof_test_… correspond à l'environnement test (staging) - cof_sandbox_… correspond à l'environnement sandbox (éphémère 24 h) Les préfixes cof_rk_live_, cof_rk_test_ et cof_rk_sandbox_ correspondent aux clés restreintes (scopes limités). Les tokens MCP utilisent cof_mcp_live_, cof_mcp_test_ et cof_mcp_sandbox_.

Vérifier votre contexte courant

L'appel GET /v1/me est le réflexe à avoir au démarrage : il confirme le workspace, l'environnement et les scopes de la clé. L'exemple ci-dessous le montre dans chaque langage.

curl -s https://api.coffrify.com/v1/me \
  -H "Authorization: Bearer cof_test_xxxxxxxxxxxxxxxxxxxx"

Réponse de GET /v1/me

La réponse expose le workspace, les scopes accordés et surtout l'environnement détecté (live, test ou sandbox), déduit du préfixe de la clé. C'est ce champ qui garantit que vous appelez le bon environnement.

{
  "workspace": {
    "id": "ws_01hx9b7z2kfm3q8n4p0r5s6t7u",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "plan": "pro",
    "is_personal": false
  },
  "api_key": {
    "id": "key_01hx9b7z2kfm3q8n4p0r5s6t7u",
    "name": "CI staging",
    "key_prefix": "cof_test_xxxx",
    "scopes": ["transfers:read", "transfers:write", "webhooks:read"],
    "environment": "test",
    "last_used_at": "2026-06-06T10:42:00.000Z",
    "created_at": "2026-04-01T08:00:00.000Z"
  },
  "scopes": ["transfers:read", "transfers:write", "webhooks:read"],
  "environment": "test"
}

Lister vos workspaces

Avec une clé API (cof_live_… ou cof_test_…), GET /v1/workspaces retourne uniquement le workspace auquel la clé appartient, avec le rôle fictif api_key. Avec une session utilisateur (cookie Supabase), il retourne tous les workspaces dont vous êtes propriétaire ou membre, chacun avec son rôle réel (owner, admin, member).

curl -s https://api.coffrify.com/v1/workspaces \
  -H "Authorization: Bearer cof_live_xxxxxxxxxxxxxxxxxxxx"

Réponse de GET /v1/workspaces

Avec une clé API, la liste se limite au workspace propriétaire de la clé. La réponse confirme son id et son nom, utiles pour verrouiller vos appels sur le bon espace.

{
  "object": "list",
  "data": [
    {
      "id": "ws_01hx9b7z2kfm3q8n4p0r5s6t7u",
      "name": "Acme Corp",
      "role": "api_key",
      "plan": "pro"
    }
  ]
}

Erreurs fréquentes

La plupart des erreurs viennent d'une clé absente, invalide ou utilisée dans le mauvais environnement. Le tableau ci-dessous indique la cause et la résolution.

Bonnes pratiques

En-têtes de réponse utiles

Plusieurs en-têtes accompagnent les réponses et aident au débogage (environnement, identifiant de requête). Le tableau ci-dessous les décrit.

Voir aussi

• Créer votre première clé API
• Authentification et scopes
• Limites de débit (rate limiting)
• Rotation de clé API
• Tokens MCP