Aller au contenu
Accueil moxon

Génération de QR Code

L'endpoint /qrcode génère un QR Code à partir d'une URL fournie en paramètre. Cet endpoint est pratique pour générer rapidement une image au format PNG.

gethttps://api.moxon.dev/v4/qrcode
Essayerget/v4/qrcode

Paramètres

  • urlstringrequis

    L'URL à encoder dans le QR Code. Doit contenir l'adresse complète

  • format"png" | "base64"optionnel

    Format de réponse : png (défaut, image directe) ou base64 (data URL en JSON)

  • sizenumberoptionnel

    Taille de l'image en pixels (50-2000, défaut 200)

  • marginnumberoptionnel

    Zone de silence en modules (0-10, défaut 4)

  • correctionstringoptionnel

    Niveau de correction d'erreur : L, M, Q ou H (défaut M)

    • L
    • M
    • Q
    • H
  • darkstringoptionnel

    Couleur des modules en hexadécimal (ex. 000000)

  • lightstringoptionnel

    Couleur de fond en hexadécimal (ex. ffffff)

  • iconstringoptionnel

    URL HTTPS d'une image à superposer au centre du QR Code

  • iconSizenumberoptionnel

    Taille de l'icône en pixels (défaut 20% de size, max 40% de size)

  • iconPaddingnumberoptionnel

    Padding blanc autour de l'icône en pixels (défaut 5, 0-50)

  • iconRadiusnumberoptionnel

    Arrondi des coins du fond de l'icône en pixels (défaut 0, max = cercle parfait)

À savoir

Lorsqu'un icon est fourni, le niveau de correction est automatiquement forcé à H pour garantir la lisibilité. L'URL de l'icône doit utiliser HTTPS, avec un timeout de 5s et une limite de 2 Mo.

Garder l'icône petite

Un iconSize élevé combiné à un iconPadding généreux recouvre davantage de modules du QR Code, le rendant difficile à scanner. Gardez la zone icône + padding bien en dessous de 40% de la size totale pour un résultat fiable.

Réponse

Par défaut (format=png), l'endpoint retourne une image PNG directe (Content-Type: image/png), utilisable dans une balise <img> :

<img src="https://api.moxon.dev/v4/qrcode?url=https://moxon.dev" alt="QR Code" />

Avec format=base64, la réponse est un objet JSON :

  • resultstring

    URI data base64 de l'image PNG du QR Code

Exemples de code

Gestion des erreurs

Si les paramètres sont manquants ou invalides, l'API retournera une erreur :

  • 400Please provide a valid URLLe paramètre url est manquant ou invalide
  • 400format must be one of: png, base64Valeur de format invalide
  • 400size must be a numberLe paramètre size n'est pas un nombre
  • 400size must be between 50 and 2000La size est hors limites
  • 400margin must be a numberLe paramètre margin n'est pas un nombre
  • 400margin must be between 0 and 10La margin est hors limites
  • 400correction must be one of: L, M, Q, HNiveau de correction invalide
  • 400Invalid color (use hex like ff6600)Une couleur dark ou light est mal formatée
  • 400Icon URL must use HTTPSL'URL de l'icon n'utilise pas HTTPS
  • 400Failed to fetch icon: HTTP {status}L'URL de l'icône a retourné une erreur
  • 400Icon URL must point to an imageLe content-type de l'icône n'est pas une image
  • 400Icon must be under 2MBL'icône dépasse la limite de 2 Mo
  • 400iconSize must be a numberLe paramètre iconSize n'est pas un nombre
  • 400iconSize must be between 10 and {max}La iconSize est hors limites (max = 40% de size)
  • 400iconPadding must be a numberLe paramètre iconPadding n'est pas un nombre
  • 400iconPadding must be between 0 and 50La iconPadding est hors limites
  • 400iconRadius must be a numberLe paramètre iconRadius n'est pas un nombre
  • 400iconRadius must be between 0 and {max}Le iconRadius est hors limites