Clés API

Clés API

Les clés API authentifient les uploads venant de ShareX, fu/Flameshot ou l'app mobile. Chaque clé porte ses propres permissions.

Créer une clé

1. Paramètres → Clés API (/settings/api-keys).
2. Cliquez sur Nouvelle clé.
3. Donnez un nom, cochez les permissions, et (optionnel) une date d'expiration.

Permissions

Permission	Autorise l'upload de	Extensions
uploadImages	Images	jpg, jpeg, png, gif, webp
uploadText	Documents	pdf, doc, docx, txt
uploadFiles	Autres fichiers	(tout le reste)
extractColors	Extraction de couleurs (optionnel)	—

Modèle de clé

• Format : sk_ + 32 caractères (ex. sk_Q9i4ukYgC7zKWRJvVhrU7plbflbIEAEx).
• Stockage : data/api-keys.json.
• Expiration : expiresAt à null (jamais) ou une date ISO ; une clé expirée est refusée.
• lastUsed : mis à jour à chaque upload réussi.

Utiliser la clé

L'upload se fait en POST multipart/form-data sur /api/upload, champ fichier file, avec l'en-tête x-api-key: sk_…. La réponse contient l'URL :

{ "url": "https://…", "thumbnail_url": "https://…|null",
  "deletion_url": "https://…?token=…", "key": { "name": "…", "lastUsed": "…" } }

Détails et codes d'erreur : Référence API.

Configuration ShareX (.sxcu)

Dans le détail d'une clé, l'onglet « Configuration ShareX » génère un fichier .sxcu prêt à l'emploi (en-tête x-api-key, multipart, URL: {json:url}). Cliquez sur Copier.

Ce fichier fonctionne avec :

• Windows → ShareX → guide
• Linux → fu/Flameshot → guide

QR code mobile

L'onglet « QR Code Mobile » encode serverUrl + apiKey + permissions pour appairer l'application mobile d'un simple scan.

🔒 Une clé donne un accès d'upload à votre serveur : ne la partagez pas, et utilisez des permissions minimales + une expiration quand c'est possible.