Guide de l'API QR Code pour développeurs

Clé API

La clé API pour votre compte peut être créée sur la page de compte. La clé API peut être incluse dans les requêtes soit comme paramètre d'URL, par exemple : https://genqrcode.com/api/public/generate?apikey=VOTRE_CLE_API, soit dans l'en-tête `GenQRCode-apikey`. Pour le reste de ce guide, nous supposerons l'utilisation de l'en-tête, car c'est l'option la plus sûre, mais les deux méthodes peuvent être utilisées de manière interchangeable. La clé API doit être considérée comme un secret, et vous ne devez pas la partager avec qui que ce soit.

Limitation de débit

La limitation de débit est appliquée pour garantir une utilisation équitable de l'API. Le niveau gratuit comprend 180 jetons par heure. Les QR codes normaux coûtent 1 jeton chacun, avec une limite horaire maximale de 180 jetons, soit 1 QR Code toutes les 20 secondes. De plus, les points de terminaison de l'appel rapide coûteront 1/50e d'un jeton, soit 2,5 QR Codes par seconde. Ces points de terminaison rapides sont recommandés lorsque la personnalisation du QR Code n'est pas nécessaire. Si la limite de jetons est dépassée, un code de statut 429 sera retourné, indiquant que la requête a été limitée.

L'utilisation de plusieurs comptes pour contourner ces limites est interdite. Si des limites plus élevées sont nécessaires, veuillez nous contacter pour obtenir un devis.

Bibliothèques

Java Library

API QR Code statique

Exemple de QR Code texte

URL	https://api.genqrcode.com/public/generate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "type": 0, "text": "https://genqrcode.com" }
Réponse

Exemple de QR Code Wi-Fi

URL	https://api.genqrcode.com/public/generate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Réponse

Exemple de QR Code couleur

URL	https://api.genqrcode.com/public/generate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Réponse

Exemple de QR Code avec motif de couleurs

URL	https://api.genqrcode.com/public/generate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Réponse

Paramètres de cadre, forme et logo

Voici tous les paramètres personnalisables pour le cadre, la forme et le logo, décrits pour vous expliquer comment les utiliser.

Paramètre	Type	Valeur par défaut	Description
style	Int	0	Style des carrés du QR Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Style des yeux intérieurs du QR Code. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Style des yeux extérieurs du QR Code. 0 1 2 3 4 5 6
frame_style	Int	0	Style du cadre autour du QR Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	Le texte à l'intérieur du cadre. Un cadre avec texte doit être configuré avant que cela ne devienne visible.
logo	String		Le logo à utiliser à l'intérieur du QR Code. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Si l'arrière-plan derrière le logo doit être supprimé.

Exemple de QR Code avec logo et forme

URL	https://api.genqrcode.com/public/generate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Réponse

API QR Code rapide

L'API QR Code rapide ne coûte que 1/50e des jetons de l'API normale. Les QR Codes sont optimisés pour la vitesse et la taille du téléchargement. Bien qu'elle prenne en charge tous les types de QR Code, elle ne prend en charge que quelques paramètres de personnalisation.

Exemple de QR Code texte rapide

URL	https://api.genqrcode.com/public/fastgenerate
Méthode de requête	POST
En-têtes	GenQRCode-apikey: API_KEY
Corps	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Réponse

API QR Code Batch rapide

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}