HopQR

• 1.0 Informations générales
  • 1.1 Conditions d'utilisation
• 2.0 Guide de démarrage rapide
• 3.0 Paramètres
  • 3.1 Paramètre data (obligatoire)
  • 3.2 Paramètre size (facultatif)
  • 3.3 Paramètre ecc (facultatif)
  • 3.4 Paramètre color (facultatif)
  • 3.5 Paramètre bgcolor (facultatif)
  • 3.6 Paramètre margin (facultatif)
  • 3.7 Paramètre logo (facultatif)
  • 3.8 Paramètre format (à venir)

Sur cette page, vous trouverez la notice d'utilisation de la commande create-qr-code, appartenant à notre API HopQR API. Sur laquelle vous pouvez créer des QR codes.

Vous pouvez également intégrer notre API à votre propre application web. Exemple: nous l'utilisons dans notre page QR code assistant

Il n'y a pas de limite de requètes, mais nous nous réservons le droit de rejeter les requètes API. Cela s'applique en particulier aux requètes nous considèrons comme abusives ou inappropriés (ex: si cela ressemble à une attaque par déni de service) Nous enregistrons l'origine de toutes les requètes (adresse IP), mais nous n'enregistrons pas le contenu des QR codes. Pour nous faciliter le travail, merci de nous informer, si votre service rique de générer plus de 10 000 requètes par jour ou si votre service à été bloqué à tort.

Envoyez une requète GET de la forme suivante pour obtenir un QR code sour forme d'image PNG https://qr.hopsite.fr/api/v1/create-qr-code/?data=[URL-encoded-text]&size=[pixels]

Vous pouvez le tester directement dans votre navigateur en recherchant l'URL suivant: https://qr.hopsite.fr/api/v1/create-qr-code/?data=HelloWorld!&size=20

Comme vous pouvez le voir, il est facile d'intégrer un QR code dans vos documents HTML en utilisant la balise <img>. La balise <img>
<img src="https://qr.hopsite.fr/api/v1/create-qr-code/?data=HelloWorld!&size=10"/>
produit / affiche l'image du QR code suivante:

L'API prend uniquement en compte un champ data avec un jeu de caractères au format UTF-8.

La commande prend en charge une large gamme de paramètres pour configurer la création de QR code. Utilisez simplement des paramètres supplémentaires en ajoutant &[nom-paramètre]=[valeur-paramètre] à votre requète.

Le texte à intégrer dans le QR code (URL encoded, les développeurs PHP peuvent utiliser urlencode()).

• Nombre de caractères minimal:
  1
• Nombre de caractères maximal:
  Dépend du paramètre ecc (plus la redondance de données est utilisée, moins vous pourrez intégrer de caractères à votre QR code) et d'autres facteurs, qui sont trop compliqués à détaillés ici d'une manière concise. Néanmoins un QR code contenant jusqu'à 900 caractères devrait fonctionner en général.
• Bonne pratique:
  Le plus court est le mieux. De nombreux téléphones portables plus anciens ont des problèmes avec les QR codes > Version 4 (avec une matrice de 33×33 pixels), vous devriez utiliser le moins de caractères possible. Nous vous suggerons d'utiliser des raccourcisseurs d'URL comme bitly pour de très long URLs. Cependant, les scanners industriels ne devraient pas avoir de problème avec les QR codes complexes.

Spécifie la taille de chaque pixel du QR code que vous voulez générer (en pixels).

• Format:
  [entier]
• Valeur minimale:
  1
• Valeur maximale:
  50
• Exemples valides:
  12
  42
• Exemples invalides:
  20x20 (format invalide)
  0 (plus petit que le format minimum)
  64 (plus grand que le format minimum)
• Par defaut (utilisé si pas de valeur renseigné ou format invalide):
  10

Le paramtre ECC détermine le degré de redondance de données. Plus il y a de redondance, plus les données peuvent être restaurées si le QR code est endommagé. (ex: rayures sur l'autocollant du QR code ou autre problème causant un masquage d'une partie du QR code)

• Valeurs possibles:
  L (bas, ~7% de données détruites peuvent être corrigées)
  M (moyen, ~15% de données détruites peuvent être corrigées)
  Q (qualité, ~25% de données détruites peuvent être corrigées)
  H (haut, ~30% de données détruites peuvent être corrigées)
• Par defaut (utilisé si pas de valeur renseigné ou format invalide):
  L
• Bonne pratique:
  L. Une correction ECC élevée donnera un QR code avec plus de données, donc avec plus de pixels en une matrice plus grande. De nombreux téléphones portables plus anciens ont des problèmes avec les QR codes > Version 4 (avec une matrice de 33×33 pixels), la correction ECC la plus plus basse est le meilleur choix pour un objectif commun - Les anciens lecteurs de QR codes sont un problème plus fréquent qu'un QR code endommagé.

La couleur des pixels de données ont une valeur RVB.

• Format:
  Hexadecimal long format ([a-fA-F] six caractères, ex: 00f00ff pour du bleu)
  
• Exemples valides:
  FF0000 (rouge)
  0000ff (bleu)
  556B2F (Vert Olive Foncé)
• Exemples invalides:
  GG00AA ("G" n'est pas un caractère valide)
  4ff0a (il manque un caractère)
  7f (=127))
• Par defaut (utilisé si pas de valeur renseigné ou format invalide):
  ffffff (=noir)
• Bonne pratique:
  ffffff (=noir). Sinon une couleur la plus sombre possible par rapport au fond afin d'avoir un bon contraste. Une couleur utile peut être trouvée en recherchant une couleur dite Couleur du Web.

La couleur fond à une valeur RVB.

• Format:
  Hexadecimal long format ([a-fA-F] six caractères, ex: 00f00ff pour du bleu)
  
• Exemples valides:
  FF0000 (rouge)
  0000ff (bleu)
  556B2F (Vert Olive Foncé)
• Exemples invalides:
  GG00AA ("G" n'est pas un caractère valide)
  4ff0a (il manque un caractère)
  7f (=127))
• Par defaut (utilisé si pas de valeur renseigné ou format invalide):
  000000 (=blanc)
• Bonne pratique:
  000000 (=blanc). Sinon une couleur la plus claire possible par rapport aux pixels afin d'avoir un bon contraste. Une couleur utile peut être trouvée en recherchant une couleur dite Couleur du Web.

Largeur de la marge en pixels (taille des piexls du Qr code). La marge aura toujours la même couleur que le fond (c.f. bgcolor). Sa taille est déterminée par la largeur de des pixels définie par size.

• Format:
  [entier]
• Valeur minimale:
  0
• Valeur maximale:
  20
• Exemples valides:
  1
  12
• Exemples invalides:
  -1 (moins que la valeur minimum)
  1487 (plus que la valeur minimum)
  a (pas un chiffre)
• Par defaut (utilisé si pas de valeur renseigné ou format invalide):
  1

Image visible au milieu du QR Code. Ce paramètre doit contenir l'url d'une image. Pour l'utilisation de ce paramètre il est préférable d'avoir un ecc de type M, Q ou H car, l'image couvre une partie du QR Code.

• Format:
  [url]
• Exemples valides:
  https://images.google.com/images/branding/googlelogo/1x/googlelogo_light_color_272x92dp.png
  https://www.google.com/logos/doodles/2023/2023-womens-world-cup-quarter-finals-aug-12-6753651837110161-s.png
• Exemples invalides:
  image.png (le format doit être un url)
  https://qr.hopsite.fr/_Ressources/Favicon/favicon.ico (l'image doit être au format png ou jpg)