Documentation de l'API
Référence complète des paramètres
1. Commande create-qr-code
1.1 Informations générales
La commande create-qr-code permet de créer des QR codes via notre API. Vous pouvez également l'intégrer à votre propre application web.
Endpoint : /api/v1/create-qr-code/ - méthode GET
1.2 Guide de démarrage rapide
Envoyez une requête GET de la forme suivante pour obtenir un QR code en PNG :
/api/v1/create-qr-code/?data=[texte-encodé-URL]&size=[pixels]
Intégrez un QR code dans vos documents HTML avec la balise <img> :
<img src="/api/v1/create-qr-code/?data=HelloWorld!&size=10"/>
L'API accepte du texte encodé en UTF-8.
1.3 Paramètres
Ajoutez des paramètres avec &[nom]=[valeur].
data
- obligatoire
- Description
- Le texte à intégrer dans le QR code (URL encodé).
- Min. caractères
- 1
- Max. caractères
- ~900 (dépend du niveau ECC)
- Bonne pratique
- Le plus court est le mieux. Utilisez un raccourcisseur d'URL pour les longues URLs.
size
- facultatif
- Format
- [entier]
- Min.
- 1
- Max.
- 50
- Défaut
- 10
- Exemples valides
- 12, 42
- Exemples invalides
- 20x20 (format invalide), 0 (trop petit), 64 (trop grand)
ecc
- facultatif
- Valeurs
- L (bas ~7%), M (moyen ~15%), Q (qualité ~25%), H (haut ~30%)
- Défaut
- L
- Bonne pratique
- L pour un usage général - les vieux lecteurs posent plus souvent problème qu'un QR code endommagé.
color
- facultatif
- Format
- Hexadécimal 6 caractères [a-fA-F0-9]
- Exemples valides
- FF0000 (rouge), 0000ff (bleu), 556B2F (vert olive)
- Exemples invalides
- GG00AA (caractère invalide), 4ff0a (manque un char)
- Défaut
- 000000 (noir)
- Bonne pratique
- Couleur la plus sombre possible par rapport au fond.
bgcolor
- facultatif
- Format
- Hexadécimal 6 caractères [a-fA-F0-9]
- Exemples valides
- FF0000 (rouge), 0000ff (bleu), 556B2F (vert olive)
- Exemples invalides
- GG00AA (caractère invalide), 4ff0a (manque un char)
- Défaut
- ffffff (blanc)
- Bonne pratique
- Couleur la plus claire possible par rapport aux pixels.
margin
- facultatif
- Format
- [entier]
- Min.
- 0
- Max.
- 20
- Défaut
- 1
- Exemples valides
- 1, 12
- Exemples invalides
- -1 (négatif), 1487 (trop grand), a (pas un chiffre)
logo
- facultatif
- Format
- [url] d'une image PNG ou JPG
- Note
- Utiliser un ECC M, Q ou H recommandé car l'image couvre une partie du QR code.
- Exemples invalides
- image.png (pas une URL), favicon.ico (format non supporté)
style
- facultatif
- Valeurs
- square, rounded, circle, gapped, vertical, horizontal
- Défaut
- square
- Description
- Forme des modules (pixels) du QR code.
- Note
- PNG uniquement - ignoré en SVG.
format
- facultatif
- Valeurs
- png, svg
- Défaut
- png
- Description
- Format de sortie du QR code.
- Note SVG
- En mode SVG, les paramètres size, style et logo sont ignorés.
watermark
- facultatif
- Format
- [texte]
- Max. caractères
- 100
- Description
- Texte à afficher sous le QR code.
- Note
- PNG uniquement - ignoré en SVG.
- Bonne pratique
- Ajouter votre URL ou nom de domaine pour identifier l'origine du QR code.
2. Commande create-totp-qr-code
La commande create-totp-qr-code génère un QR code au format otpauth://totp/ pour l'authentification à deux facteurs (2FA).
Endpoint : /api/v1/create-totp-qr-code/ - méthode GET
Les paramètres QR code (size, ecc, color, bgcolor, margin, logo, style, watermark) sont identiques à ceux de create-qr-code.
2.1 Paramètres TOTP
issuer
- obligatoire
- Description
- Nom du service / émetteur (ex : MonService, GitHub).
account
- obligatoire
- Description
- Identifiant du compte (ex : user@example.com).
secret
- obligatoire
- Format
- Clé secrète encodée en base32 (ex : JBSWY3DPEHPK3PXP).
algorithm
- facultatif
- Valeurs
- SHA1, SHA256, SHA512
- Défaut
- SHA1
digits
- facultatif
- Valeurs
- 6, 8
- Défaut
- 6
period
- facultatif
- Format
- [entier] en secondes
- Défaut
- 30