Accéder à l'API et créer une clé

L'API PixShrink te permet d'intégrer la conversion d'images directement dans tes propres applications ou scripts. Elle est réservée au plan Pro Plus. Cette page explique comment accéder à l'interface de gestion, créer ta première clé API et l'utiliser pour t'authentifier.

Prérequis

Tu dois être connecté à un compte PixShrink actif avec le plan Pro Plus. Si tu es sur le plan Gratuit ou Pro Lite, la page API est visible mais verrouillée — un bouton Passer en Pro+ te redirige vers /tarifs/.

Accéder à la page de gestion

1. Connecte-toi à ton compte.
2. Dans le header de ton espace compte, clique sur le lien API (visible uniquement pour les Pro Plus).
3. Tu arrives sur /compte/api/, qui contient :
   • un lien vers le guide d'utilisation intégré (/compte/api/guide/)
   • un lien vers la documentation OpenAPI interactive (/api/v1/docs)
   • le formulaire de création de clé
   • le tableau de tes clés existantes
   • la section de gestion des webhooks

Créer une clé API

1. Sur /compte/api/, repère la section Créer une clé.
2. Saisis un nom descriptif dans le champ Nom (libellé interne) — par exemple CLI prod ou Plugin WordPress. Ce nom est uniquement pour toi, il n'est pas transmis à l'API.
3. Clique sur Créer une clé.
4. La page se recharge et affiche un encart jaune Ta nouvelle clé API avec ta clé en clair et un bouton Copier.

Format de la clé

Une clé API PixShrink ressemble à ceci :

px_live_a1b2c3d4.aBcDeFgHiJkLmNoPqRsTuVwXyZ1234567890aBcDeFgHi

Elle est composée d'un préfixe lisible (px_live_ + 8 caractères) et d'un secret de 40 caractères, séparés par un point. Tu as besoin de la clé complète pour t'authentifier.

Utiliser ta clé pour s'authentifier

Ajoute le header suivant à toutes tes requêtes API :

Authorization: Bearer px_live_a1b2c3d4.xxxxx...

Exemple avec curl :

curl https://pixshrink.app/api/v1/me \
  -H "Authorization: Bearer px_live_a1b2c3d4.xxxxx..."

Erreurs d'authentification

Code HTTP	Message	Cause	Solution
401	Clé API vide.	Header Authorization: Bearer présent mais valeur vide	Vérifier que la clé est bien remplie après Bearer
401	Clé API mal formée.	Point séparateur manquant ou préfixe non reconnu	Copier la clé intégralement depuis /compte/api/
401	Clé API inconnue.	Le préfixe n'existe pas en base (mauvaise clé ou clé d'un autre compte)	Vérifier quelle clé est utilisée
401	Clé API révoquée.	La clé a été révoquée	Créer une nouvelle clé sur /compte/api/
401	Clé API invalide.	Préfixe connu mais secret incorrect (clé tronquée ou altérée)	Copier la clé sans caractères supplémentaires
403	Clé API requise.	Requête sans header Authorization	Ajouter le header à toutes les requêtes
403	L'API est réservée aux comptes Pro+.	Clé valide mais compte non Pro Plus	Passer au plan Pro Plus sur /tarifs/

Consulter la documentation interactive

La spécification OpenAPI complète est disponible sur /api/v1/docs (ReDoc, public — aucune clé requise pour la consulter). Le schéma JSON brut est disponible sur /api/v1/schema. Le guide intégré avec des exemples curl et Python est accessible sur /compte/api/guide/ (Pro Plus requis).

Questions fréquentes

Combien de clés puis-je créer ?

Tu peux créer plusieurs clés — par exemple une par application ou environnement (dev, prod). Cela te permet de révoquer une clé compromise sans affecter les autres intégrations.

Puis-je retrouver la valeur d'une clé après sa création ?

Non. PixShrink ne stocke jamais la clé en clair — seul un hash est conservé. Si tu perds une clé, tu dois la révoquer et en créer une nouvelle. Vos applications devront être mises à jour avec la nouvelle valeur.

Ma clé est-elle liée à mon abonnement ?

Oui. Si ton plan passe en dessous de Pro Plus (downgrade ou annulation), les appels API avec tes clés seront rejetés avec un 403 — L'API est réservée aux comptes Pro+. Tes clés sont conservées dans l'interface mais inopérantes.

Voir aussi : Révoquer une clé API · Convertir des images via l'API · Configurer des webhooks