Installer et utiliser le SDK Python (coffrify-python)

Le SDK Python coffrify-python est la façon la plus rapide d'intégrer l'API Coffrify dans vos scripts et applications Python. Il encapsule l'authentification par clé API (cof_live_…, cof_test_…, cof_sandbox_…), la gestion des en-têtes d'upload, la pagination par curseur, et la remontée d'erreurs structurées. Ce guide vous accompagne de l'installation jusqu'à la création d'un premier transfert et à la récupération de votre contexte d'authentification via /v1/me.

Prérequis

• Python 3.9 ou supérieur
• Une clé API Coffrify (format cof_live_… pour la production, cof_test_… pour les tests, cof_sandbox_… pour le bac à sable)
• pip ou tout gestionnaire de paquets Python compatible

Installation

$ pip install coffrify-python

Le paquet expose un client synchrone (CoffrifyClient) et un client asynchrone (AsyncCoffrifyClient). Les exemples ci-dessous utilisent le client synchrone, adapté aux scripts et aux tâches ponctuelles.

Authentification

Toutes les requêtes authentifiées passent par le header HTTP Authorization: Bearer <votre_clé>. L'API accepte trois familles de préfixes : cof_live_… (production), cof_test_… (test), cof_sandbox_… (bac à sable éphémère). Chaque clé est liée à un workspace et à un ensemble de scopes (ex. transfers:read, transfers:write). L'endpoint /v1/me ne requiert aucun scope particulier : il retourne le contexte courant de la clé, y compris la liste de ses scopes réels.

Corps de la requête POST /v1/transfers

Exemples d'appels

# Vérifier le contexte de la clé
curl -s https://api.coffrify.com/v1/me \
  -H "Authorization: Bearer cof_test_xxxxxxxxxxxxxxxxxxxx"
 
# Créer un transfert
curl -s -X POST https://api.coffrify.com/v1/transfers \
  -H "Authorization: Bearer cof_test_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [{"name": "rapport.pdf", "size": 204800, "mime_type": "application/pdf"}],
    "transfer_title": "Rapport Q2 2026",
    "expires_in_hours": 72,
    "recipient": "client@exemple.fr"
  }'

Réponses

GET /v1/me retourne le contexte complet de la clé appelante :

{
  "workspace": {
    "id": "ws_01hxyz...",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "plan": "pro",
    "is_personal": false
  },
  "api_key": {
    "id": "key_01hxyz...",
    "name": "CI/CD Pipeline",
    "key_prefix": "cof_test_xxxx",
    "scopes": ["transfers:read", "transfers:write"],
    "environment": "test",
    "last_used_at": "2026-06-06T14:32:00Z",
    "created_at": "2026-01-15T09:00:00Z"
  },
  "scopes": ["transfers:read", "transfers:write"],
  "environment": "test"
}

POST /v1/transfers retourne le transfert créé (HTTP 201), les URLs d'upload pré-signées et l'URL de partage publique :

{
  "transfer": {
    "id": "trf_01hxyz...",
    "short_code": "aB3dE9",
    "transfer_title": "Rapport Q2 2026",
    "status": "pending",
    "expires_at": "2026-06-09T14:32:00Z",
    "max_downloads": null,
    "total_downloads": 0,
    "scan_status": "pending",
    "encryption_mode": null,
    "created_at": "2026-06-06T14:32:00Z"
  },
  "upload_urls": [
    {
      "file_id": "rapport.pdf",
      "url": "https://storage.coffrify.com/upload/signed?token=...",
      "headers": {
        "Content-Type": "application/pdf"
      }
    }
  ],
  "share_url": "https://files.coffrify.com/aB3dE9",
  "totp_secret": null
}

Erreurs

Voir aussi

• Référence GET /v1/me
• Référence POST /v1/transfers
• Référence GET /v1/transfers
• Authentification et scopes
• Gérer la pagination par curseur
• Utiliser les Webhooks
• Intégration MCP pour agents IA