Compresser une image API

Compresser une image API, ImageMini connecte la tâche à votre propre application : vous envoyez le fichier, interrogez l'état de la tâche et téléchargez le résultat. Les points de terminaison fonctionnent côté serveur, sans intervention du navigateur.

Démarrage rapide

  1. Créez une clé dans la section API Développeur de votre compte ; la clé en texte brut n'est affichée qu'au moment de sa création.
  2. Envoyez la requête à https://api.pixepi.com avec l'en-tête Authorization: Bearer <key>.
  3. Interrogez la tâche dans la réponse avec GET https://api.pixepi.com/api/v1/jobs/{id} ; dès que le statut passe à done, téléchargez le résultat depuis download_url.

Exemple de requête

curl -X POST "https://api.pixepi.com/api/v1/apps/gorsel-kucult/run" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -F "[email protected]" \
  -F "options[quality]=82" \
  -F "options[format]=same"

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/jobs/42"

Points de terminaison de cet outil

MéthodeCheminDescription
POST/runExécute l'outil, lance une tâche et renvoie le résultat.

Options

Les options sont transmises sous la forme options[<field>] ; un champ laissé vide applique sa valeur par défaut.

ChampValeursPar défaut
options[quality]
Qualité
40–9582
options[max_side]
Limite du grand côté (facultatif)
0–6000vide
options[format]
Format de sortie
same · jpeg · webp · pngsame
options[auto_rotate]
Corriger l'orientation du smartphone
activé · désactivéactivé

Points de terminaison partagés

MéthodeCheminDescription
GET/api/v1/appsCatalogue d'API
GET/api/v1/apps/gorsel-kucultSpécification de l'outil
GET/api/v1/jobs/{id}Statut de la tâche
GET/api/v1/jobs/{id}/downloadTélécharger le résultat de la tâche
GET/api/v1/usageRésumé d'utilisation
GET/api/v1/openapi.jsonDocument OpenAPI 3.1

Limites

  • Au maximum 100 MB par fichier.
  • Traitement par lot : envoyez le même champ file plusieurs fois.
  • Les quotas et les informations d'abonnement sont rattachés à votre compte ; vérifiez l'état actuel avec GET /api/v1/usage.

Codes d'erreur

CodeSignification
unauthorizedLa clé d'API est manquante ou invalide.
forbiddenCette opération n'est pas autorisée avec cette clé.
not_foundOutil, tâche ou enregistrement introuvable (404 également pour accès inter-comptes).
invalid_inputÉchec de validation des données saisies (champ manquant ou mal formé, date invalide, etc.).
invalid_requestLa requête est mal formée.
too_largeLa taille du fichier ou du corps dépasse la limite autorisée.
unsupported_mediaCe type de fichier n'est pas accepté.
not_supportedCet outil ne peut pas fonctionner sur ce point de terminaison (application avec état).
not_readyLa tâche n'est pas encore terminée.
expiredLe fichier généré a expiré.
no_outputAucun fichier à télécharger pour cette tâche.
invalid_pathChemin de sortie invalide.
quota_exceededQuota ou limite de requêtes dépassé.
rate_limitedTrop de requêtes en peu de temps ; veuillez patienter avant de réessayer.
csrfÉchec de la vérification du formulaire de navigation (l'API externe utilise des clés).
conflictL'opération entre en conflit avec l'état actuel.
unavailableL'outil est temporairement indisponible.
internal_errorErreur interne du serveur inattendue.

Documents

Foire aux questions

Comment obtenir une clé API ?

Créez une clé dans la section API Développeur de votre compte ; la clé n'est affichée qu'une seule fois, au moment de sa création.

Comment envoyer une requête ?

Les points de terminaison fonctionnent sur https://api.pixepi.com ; chaque requête doit inclure l'en-tête "Authorization: Bearer <clé>".

Quels fichiers l'API ImageMini accepte-t-elle ?

Types acceptés : JPG · JPEG · PNG · WEBP. La limite est de 100 MB par fichier ; les options sont identiques à celles de la page de l'outil.

Comment interpréter une réponse d'erreur ?

Le corps de l'erreur contient les champs {ok:false, error, code, request_id} ; les valeurs des codes figurent dans le tableau des codes d'erreur.