Réponse exemple
GET/v1/transfers/{id}/qrcodeRenvoie l'URL de partage publique d'un transfert et un QR code PNG pointant vers cette URL.Cet endpoint produit un QR code pour un transfert existant. Il résout d'abord le transfert via son id dans le workspace authentifié, puis construit l'URL de partage publique au format https://files.coffrify.com/{short_code}. Le QR code n'est pas généré côté Coffrify : la réponse contient un champ qr_url, une URL PNG servie par le proxy public api.qrserver.com, que vous pouvez afficher directement dans une balise <img> ou télécharger. La réponse expose aussi le short_code et l'expires_at du transfert afin que vous puissiez générer vous-même le QR côté client à partir de share_url si vous préférez ne pas dépendre du proxy externe.
Authentification
Requiert une clé API valide avec le scope transfers:read. La clé doit appartenir au même workspace que le transfert visé : la requête filtre sur workspace_id, donc un transfert d'un autre workspace renverra 404 not_found même si l'identifiant est correct.
Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| id | string (path) | Oui | Identifiant du transfert, transmis dans le chemin de l'URL. |
| size | integer (query) | Non | Côté du QR code en pixels (image carrée). Valeurs autorisées : 128, 200, 256, 300, 400, 512, 600, 800, 1000. Toute autre valeur (ou absence) retombe sur 300. |
| ecc | string (query) | Non | Niveau de correction d'erreur du QR code : L, M, Q ou H. Toute autre valeur (ou absence) retombe sur M. |
Réponse
La réponse est un objet JSON. transfer_id et short_code identifient le transfert ; share_url est l'URL publique encodée dans le QR code ; qr_url est l'URL PNG du proxy public (déjà construite avec size, ecc et data URL-encodé). qr_size et ecc renvoient les valeurs effectivement appliquées (après normalisation). expires_at est la date d'expiration du transfert. Le champ note rappelle que qr_url passe par un proxy public et que les usages sensibles à la confidentialité devraient générer le QR côté client à partir de share_url.
| Champ | Type | Description |
|---|---|---|
| transfer_id | string | Identifiant du transfert. |
| short_code | string | Code court public du transfert, segment final de l'URL de partage. |
| share_url | string | URL de partage publique : https://files.coffrify.com/{short_code}. |
| qr_url | string | URL PNG du QR code (proxy public api.qrserver.com), prête à afficher ou télécharger. |
| qr_size | integer | Taille effective du QR en pixels (valeur normalisée). |
| ecc | string | Niveau de correction d'erreur effectif (L, M, Q ou H). |
| expires_at | string | null | Date d'expiration du transfert (ISO 8601), ou null si pas d'expiration. |
| note | string | Avertissement de confidentialité sur l'usage du proxy public. |
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 401 missing_api_key / invalid_api_key | Clé API absente, invalide, expirée ou révoquée. | Fournir un en-tête Authorization: Bearer avec une clé API active. |
| 403 scope_missing | La clé n'a pas le scope transfers:read. | Émettre ou utiliser une clé disposant du scope transfers:read. |
| 404 not_found | Aucun transfert avec cet id dans le workspace de la clé. | Vérifier l'identifiant et que le transfert appartient bien au workspace authentifié. |
| 429 rate_limited | Quota de requêtes par minute dépassé pour le workspace (endpoint de lecture). | Respecter l'en-tête Retry-After avant de réessayer. |
| 500 internal_error | Erreur lors de la lecture du transfert en base. | Réessayer ; si le problème persiste, contacter le support avec le request_id. |
Voir aussi
- GET /v1/transfers/{id} — détail complet d'un transfert (statut, expiration, destinataires).
- GET /v1/transfers — liste paginée des transferts du workspace.
- POST /v1/transfers — création d'un transfert et de son lien de partage.