Documentation de l'API Code QR

Créer des codes QR

Créez un QR code dynamique pour les URL et destinations gérées, ou un QR code statique pour les payloads WiFi.

POST https://createqr.app/api/v1/create

Envoyez du JSON uniquement. Pour l’authentification par clé, l’en-tête est la meilleure pratique. Les champs clés du corps sont là pour la compatibilité avec les intégrations existantes.

Démarrage rapide (cURL)

Cet exemple d’URL dynamique est le chemin hello-world le plus rapide.

curl -sS -X POST 'https://createqr.app/api/v1/create' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ck_live_XXXXXXXXXXXXXXXXXXXXXXXX' \
  -d '{"data":"https://createqr.app","qrtype":"dynamic"}'

Authentification et compatibilité

Recommandé : Autorisation : Porteur <key>
Également accepté : X-API-Key
Repli JSON : apikey ou api_key
Content-Type doit être application/json
Les méthodes non POST renvoient 405 method_not_allowed

Main Parameters

Parameter	Type	Default	Description
`apikey`	String	`Required`	Secret API key. Recommandé dans l'en-tête d'autorisation (au porteur). Le corps JSON apikey/api_key est également accepté.
`data`	String	`Required`	Contenu à encoder. Un QR dynamique nécessite une URL valide. Un QR statique accepte uniquement des chaînes WiFi.
`qrtype`	String	`dynamic`	Mode QR : dynamic pour les URL et destinations gérées, ou static uniquement pour le WiFi.
`title`	String	`Facultatif`	Titre QR affiché dans le tableau de bord (réduit à 120 chars).
`folderid`	Number	`Facultatif`	ID de dossier entier positif appartenant à votre compte.

Paramètres de couleur et de forme

Parameter	Type	Default	Description
`transparent`	String/Bool	`off`	on/off, vrai/faux, 1/0, oui/non accepté.
`backcolor`	String	`#FFFFFF`	Couleur hexadécimale d'arrière-plan au format #RRGGBB.
`frontcolor`	String	`#000000`	Couleur hexadécimale des points principaux en #RRGGBB format.
`gradient`	String/Bool	`off`	Activer le dégradé de points bicolores.
`radial`	String/Bool	`off`	Activer le dégradé radial (fonctionne lorsque le dégradé est activé).
`gradient_color`	String	`#15A97C`	Deuxième couleur de dégradé dans #RRGGBB.
`marker_out_color`	String	`#000000`	Couleur du cadre autour des points d'angle in #RRGGBB format.
`marker_in_color`	String	`#000000`	Couleur des points d'angle in #RRGGBB format.
`pattern`	String	`default`	Style de point du corps preset. `default` `circle` `star` `diamond` `sparkle` `danger` `cross` `plus` `x` `heart` `shake` `blob` `special-circle-orizz` `special-circle-vert` `special-circle` `special-diamond` `ribbon` `oriental` `ellipse`
`marker`	String	`default`	Style du cadre autour des points d'angle. `corner_1` `corner_2` `corner_3` `corner_4` `corner_5` `corner_6` `corner_7` `corner_8`
`marker_in`	String	`default`	Type des points d'angle. `corner_in_1` `corner_in_2` `corner_in_3` `corner_in_4` `corner_in_5` `corner_in_6` `corner_in_7` `corner_in_8`
`optionlogo`	String	`none`	none, chemin de filigrane SVG local recommandé, chemin PNG local existant ou données d'image base64. `none` `/images/watermarks/v2/01-link.svg` `/images/watermarks/v2/02-location.svg` `/images/watermarks/v2/03-email.svg` `/images/watermarks/v2/04-whatsapp.svg` `/images/watermarks/v2/05-wifi.svg` `/images/watermarks/v2/06-vcard.svg` `/images/watermarks/v2/07-menu.svg` `/images/watermarks/v2/08-app.svg` `/images/watermarks/v2/09-video.svg` `/images/watermarks/v2/10-feedback.svg` `/images/watermarks/v2/11-event.svg` `/images/watermarks/v2/12-coupon.svg` `/images/watermarks/v2/13-music.svg` `/images/watermarks/v2/14-social.svg` `/images/watermarks/v2/15-paypal.svg` `/images/watermarks/v2/16-bitcoin.svg` `/images/watermarks/v2/17-scan.svg` `data:image/*;base64,...`
`no_logo_bg`	String/Bool	`on`	Supprime la plaque d’arrière-plan du logo.

Paramètres du cadre

Parameter	Type	Default	Description
`outer_frame`	String	`none`	Préglage de style de cadre. `none` `svg_frame_01` `svg_frame_02` `svg_frame_03` `svg_frame_04` `svg_frame_05` `svg_frame_06` `svg_frame_07` `svg_frame_08` `svg_frame_09` `svg_frame_10` `svg_frame_11` `svg_frame_12` `svg_frame_13` `svg_frame_14` `svg_frame_15` `svg_frame_16` `svg_frame_19` `svg_frame_22` `svg_frame_23` `svg_frame_26` `svg_frame_27` `svg_frame_28` `svg_frame_29` `svg_frame_30` `svg_frame_31` `svg_frame_33` `svg_frame_34` `svg_frame_35` `svg_frame_36` `svg_frame_38` `svg_frame_42` `caption_only_v1` `classic_thin_outline_v1` `classic_rounded_outline_v1` `classic_bottom_bar_v1` `classic_top_bar_v1` `classic_corner_brackets_v1` `classic_speech_bubble_v1` `colorful_blue_panel_v1` `colorful_teal_accents_v1` `colorful_coral_accents_v1` `colorful_botanical_v1` `colorful_celebration_v1` `colorful_cafe_v1` `illustrated_circle_v1` `illustrated_brackets_bottom_v1` `illustrated_speech_label_v1` `illustrated_brackets_top_v1` `illustrated_banner_filled_v1` `illustrated_banner_outline_v1` `illustrated_cloche_v1` `illustrated_beer_v1` `illustrated_chef_v1` `illustrated_shop_v1` `illustrated_drink_v1` `illustrated_coffee_v1` `illustrated_receipt_v1` `illustrated_arrow_v1` `illustrated_gift_v1` `illustrated_cinema_v1` `colorful_womens_day_mimosa_v1` `colorful_womens_day_venus_blossom_v1` `colorful_womens_day_ribbon_v1` `colorful_womens_day_floral_portrait_v1` `colorful_womens_day_tulip_garden_v1` `colorful_halloween_pumpkin_v1` `colorful_halloween_friendly_ghost_v1` `colorful_halloween_witch_hat_v1` `colorful_halloween_bat_moon_v1` `colorful_halloween_haunted_house_v1` `colorful_tequila_day_agave_v1` `colorful_tequila_day_margarita_v1` `colorful_tequila_day_bottle_v1` `colorful_tequila_day_lime_sun_v1` `colorful_tequila_day_desert_cactus_v1` `colorful_new_year_fireworks_v1` `colorful_new_year_champagne_v1` `colorful_new_year_midnight_clock_v1` `colorful_new_year_party_hat_v1` `colorful_new_year_disco_ball_v1` `colorful_valentines_heart_wings_v1` `colorful_valentines_love_letter_v1` `colorful_valentines_swan_pair_v1` `colorful_valentines_heart_lock_v1` `colorful_valentines_rose_v1` `colorful_easter_painted_egg_v1` `colorful_easter_spring_bunny_v1` `colorful_easter_egg_basket_v1` `colorful_easter_hatching_chick_v1` `colorful_easter_spring_wreath_v1` `colorful_april_fools_jester_v1` `colorful_april_fools_jack_in_box_v1` `colorful_april_fools_moustache_glasses_v1` `colorful_april_fools_comedy_mask_v1` `colorful_april_fools_pop_up_flower_v1` `colorful_eid_crescent_lantern_v1` `colorful_eid_dates_v1` `colorful_eid_star_medallion_v1` `colorful_eid_mosque_v1` `colorful_eid_festival_garland_v1` `colorful_labor_day_hard_hat_v1` `colorful_labor_day_crossed_tools_v1` `colorful_labor_day_handshake_v1` `colorful_labor_day_gear_v1` `colorful_labor_day_raised_fist_v1` `colorful_islamic_mihrab_v1` `colorful_islamic_open_book_v1` `colorful_islamic_prayer_beads_v1` `colorful_islamic_pierced_lantern_v1` `colorful_islamic_minarets_v1` `colorful_songkran_water_bowl_v1` `colorful_songkran_elephant_v1` `colorful_songkran_jasmine_garland_v1` `colorful_songkran_water_splash_v1` `colorful_songkran_temple_roof_v1` `colorful_fathers_day_tie_v1` `colorful_fathers_day_bow_tie_v1` `colorful_fathers_day_fishing_v1` `colorful_fathers_day_grill_v1` `colorful_fathers_day_trophy_v1` `colorful_pancasila_golden_star_v1` `colorful_pancasila_unity_chain_v1` `colorful_pancasila_banyan_v1` `colorful_pancasila_bull_v1` `colorful_pancasila_rice_cotton_v1` `colorful_indonesia_independence_red_white_ribbons_v1` `colorful_indonesia_independence_monas_v1` `colorful_indonesia_independence_bunting_v1` `colorful_indonesia_independence_rosette_v1` `colorful_indonesia_independence_bamboo_v1` `colorful_hung_kings_bronze_drum_v1` `colorful_hung_kings_lotus_v1` `colorful_hung_kings_temple_gate_v1` `colorful_hung_kings_sacred_mountains_v1` `colorful_hung_kings_rice_offerings_v1` `colorful_harvest_golden_wheat_v1` `colorful_harvest_cornucopia_v1` `colorful_harvest_orchard_basket_v1` `colorful_harvest_sweetcorn_v1` `colorful_harvest_field_sunrise_v1` `colorful_thanksgiving_turkey_v1` `colorful_thanksgiving_orchard_pie_v1` `colorful_thanksgiving_oak_acorns_v1` `colorful_thanksgiving_autumn_wreath_v1` `colorful_thanksgiving_candle_table_v1` `colorful_carnival_feather_mask_v1` `colorful_carnival_jester_v1` `colorful_carnival_festival_fan_v1` `colorful_carnival_parade_drum_v1` `colorful_carnival_confetti_v1` `colorful_holi_powder_burst_v1` `colorful_holi_gulal_bowls_v1` `colorful_holi_rangoli_v1` `colorful_holi_water_colours_v1` `colorful_holi_petal_rain_v1` `colorful_columbus_day_tall_ship_v1` `colorful_columbus_day_compass_rose_v1` `colorful_columbus_day_sea_chart_v1` `colorful_columbus_day_sextant_v1` `colorful_columbus_day_three_sails_v1` `colorful_christmas_fir_tree_v1` `colorful_christmas_baubles_v1` `colorful_christmas_holly_wreath_v1` `colorful_christmas_gingerbread_v1` `colorful_christmas_snowy_cottage_v1` `colorful_chinese_new_year_lanterns_v1` `colorful_chinese_new_year_dragon_v1` `colorful_chinese_new_year_lion_dance_v1` `colorful_chinese_new_year_plum_blossoms_v1` `colorful_chinese_new_year_gold_ingots_v1` `colorful_vietnamese_new_year_apricot_blossoms_v1` `colorful_vietnamese_new_year_banh_chung_v1` `colorful_vietnamese_new_year_spring_bouquet_v1` `colorful_vietnamese_new_year_lucky_envelopes_v1` `colorful_vietnamese_new_year_kumquat_v1` `colorful_food_drink_plate_v1` `colorful_food_drink_cloche_v1` `colorful_food_drink_takeaway_coffee_v1` `colorful_food_drink_mug_v1` `colorful_food_drink_menu_v1` `colorful_travel_suitcase_v1` `colorful_travel_backpack_v1` `colorful_travel_luggage_v1` `colorful_travel_balloon_v1` `colorful_travel_location_v1` `colorful_shopping_bag_v1` `colorful_shopping_cart_v1` `colorful_shopping_gift_v1` `colorful_shopping_storefront_v1` `colorful_shopping_delivery_truck_v1` `colorful_technology_cloud_v1` `colorful_technology_atom_v1` `colorful_technology_phone_hand_v1` `colorful_technology_monitor_v1` `colorful_technology_chat_v1` `colorful_wellness_medicine_v1` `colorful_wellness_medical_bag_v1` `colorful_wellness_care_hands_v1` `colorful_wellness_wellness_leaves_v1` `colorful_wellness_health_pulse_v1` `colorful_celebration_teddy_bear_v1` `colorful_celebration_bunting_v1` `colorful_celebration_balloons_v1` `colorful_celebration_ribbon_v1` `colorful_celebration_cake_v1` `colorful_creative_stationery_v1` `colorful_creative_artist_palette_v1` `colorful_creative_camera_v1` `colorful_creative_music_v1` `colorful_creative_book_v1`
`framelabel`	String	`SCAN ME`	Étiquette de texte du cadre (ajustée à 80 caractères).
`label_font`	String	`Arial, Helvetica, sans-serif`	Pile de polices pour l'étiquette du cadre.
`custom_frame_color`	String/Bool	`off`	Activer la couleur du cadre personnalisée.
`framecolor`	String	`#000000`	Frame hex couleur au format #RRGGBB.

Créer des exemples de demande

Exemple : QR simple

No-frills, fast scan

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "https://createqr.app",
    "qrtype": "dynamic",
    "title": "Launch Landing QR",
    "transparent": "off",
    "backcolor": "#FFFFFF",
    "frontcolor": "#000000",
    "marker_out_color": "#000000",
    "marker_in_color": "#000000",
    "pattern": "default",
    "marker": "corner_1",
    "marker_in": "corner_in_1",
    "optionlogo": "none"
}

Request Outcome

Exemple : QR WiFi statique

Built for distance

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "WIFI:T:WPA;S:CreateQR Guest;P:guest-2026;H:false;;",
    "qrtype": "static",
    "title": "Guest Wi-Fi QR",
    "transparent": "off",
    "backcolor": "#0B1220",
    "frontcolor": "#FFFFFF",
    "marker_out_color": "#F4C84A",
    "marker_in_color": "#F4C84A",
    "pattern": "circle",
    "marker": "corner_3",
    "marker_in": "corner_in_3",
    "optionlogo": "none"
}

Request Outcome

Brand Color

Theme-aligned campaign

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "https://createqr.app/pricing",
    "qrtype": "dynamic",
    "title": "Pricing QR",
    "transparent": "off",
    "backcolor": "#EAF4FF",
    "frontcolor": "#033895",
    "marker_out_color": "#15A97C",
    "marker_in_color": "#15A97C",
    "pattern": "special-circle-orizz",
    "marker": "corner_4",
    "marker_in": "corner_in_4",
    "optionlogo": "none"
}

Request Outcome

Exemple : Couleur + Logo

Preset watermark icon

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "https://createqr.app/features",
    "qrtype": "dynamic",
    "title": "Feature Tour QR",
    "transparent": "off",
    "backcolor": "#033895",
    "frontcolor": "#FFFFFF",
    "marker_out_color": "#669DF4",
    "marker_in_color": "#669DF4",
    "pattern": "ribbon",
    "marker": "corner_5",
    "marker_in": "corner_in_5",
    "optionlogo": "/images/watermarks/v2/01-link.svg"
}

Request Outcome

Exemple : Campagne encadrée QR

Poster-ready "SCAN ME"

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "https://createqr.app/pricing",
    "qrtype": "dynamic",
    "title": "Pricing Poster QR",
    "transparent": "off",
    "frontcolor": "#2B0011",
    "marker_out_color": "#3B0001",
    "marker_in_color": "#3B0001",
    "pattern": "ellipse",
    "marker": "corner_8",
    "marker_in": "corner_in_7",
    "optionlogo": "none",
    "outer_frame": "balloon-top",
    "framelabel": "SCAN ME",
    "label_font": "Arial, Helvetica, sans-serif",
    "custom_frame_color": "on",
    "framecolor": "#3B0001"
}

Request Outcome

Gradient Mood

Extra style for socials

Request Method:

POST

Request URL:

https://createqr.app/api/v1/create

Request Parameters:

All parameters need to be sent as a JSON object in the request body.

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "data": "https://createqr.app/why-us",
    "qrtype": "dynamic",
    "title": "Brand Story QR",
    "transparent": "off",
    "backcolor": "#FFFFFF",
    "frontcolor": "#4B1EFF",
    "gradient": "on",
    "radial": "off",
    "gradient_color": "#FF7A00",
    "marker_out_color": "#101828",
    "marker_in_color": "#101828",
    "pattern": "special-diamond",
    "marker": "corner_6",
    "marker_in": "corner_in_8",
    "optionlogo": "none"
}

Request Outcome

Enveloppe de réponse de réussite

{
    "success": true,
    "data": {
        "qrid": "1284",
        "svg": "<svg ...>...</svg>",
        "type": "dynamic",
        "title": "Launch Landing QR",
        "dashboard_url": "https://createqr.app/app/qrs/1284",
        "download_url": "https://createqr.app/app/qrs/1284/download/svg"
    },
    "request_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Supprimer les codes QR

Supprimer un QR par ID (propriétaire uniquement).

POST https://createqr.app/api/v1/delete

Request body

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "qrid": "1284"
}

Response

{
    "success": true,
    "data": {
        "deleted": true,
        "qrid": "1284"
    },
    "request_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Liste des codes QR

Listez vos QR par pages de 100, le plus récent en premier.

POST https://createqr.app/api/v1/list

Utilisez la pagination à partir de 1. Les résultats renvoient jusqu'à 100 éléments par page.

Request body

{
    "apikey": "ck_live_XXXXXXXXXXXXXXXXXXXXXXXX",
    "pagination": "1"
}

Response

{
    "success": true,
    "data": {
        "pagination": "1",
        "page_size": 100,
        "total": 2,
        "items": [
            {
                "qrid": "1284",
                "title": "Campaign QR",
                "type": "dynamic",
                "created_at": "2026-02-17 09:12:30",
                "short_url": "https://createqr.app/r/a1b2c3",
                "dashboard_url": "https://createqr.app/app/qrs/1284"
            },
            {
                "qrid": "1269",
                "title": "Guest Wi-Fi QR",
                "type": "static",
                "created_at": "2026-02-17 08:02:08",
                "dashboard_url": "https://createqr.app/app/qrs/1269"
            }
        ]
    },
    "request_id": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Réponses d'erreur, limites et retries

Chaque réponse inclut request_id. Conservez-le lorsque vous contactez l'assistance afin que nous puissions déboguer rapidement.

Enveloppe d'erreur typique

{
    "success": false,
    "error": {
        "code": "validation_error",
        "message": "Static QR is only available for WiFi payloads."
    },
    "request_id": "5f5fbd38-f82f-49ad-bf11-f7f04ca9747a"
}

Stratégie de nouvelle tentative

429 rate_limited : réessayez avec un intervalle exponentiel plus gigue.
Honor Retry-After lorsqu'il est présent.
429monthly_quota_exceeded : attendez la réinitialisation du quota ou utilisez une clé avec quota gauche.
5xx : réessayez avec des tentatives limitées, puis alertez votre équipe.

Code d'erreur	HTTP	Quand cela se produit	Que faire
`invalid_api_key`	401	Clé API manquante ou invalide	Fournissez une clé valide via Champ de corps Bearer, X-API-Key ou JSON.
`invalid_content_type`	415	Le corps n'est pas une application/json	Envoyer le type de contenu : application/json.
`request_too_large`	413	La charge utile dépasse la limite configurée	Réduire la taille du corps, en particulier les logos base64.
`plan_upgrade_required`	403	Le plan n'est pas autorisé pour l'API	Mise à niveau vers Business à partir de la facturation.
`validation_error`	422	Champs non valides tels que l'URL, le payload statique, la couleur ou l'ID de dossier	Utilisez dynamic pour les URL et destinations gérées; utilisez static uniquement pour le WiFi.
`rate_limited`	429	Limite par minute atteinte	Réessayez avec un intervalle exponentiel et un honneur Réessayez après.
`monthly_quota_exceeded`	429	Quota mensuel épuisé	Attendez la réinitialisation ou l'ajustement du quota et des paramètres clés.
`qr_not_found`	404	La cible de suppression est manquante ou n'est pas la vôtre	Vérifiez la propriété du qrid et essayez encore une fois.
`internal_error`	500	Problème inattendu côté serveur	Réessayez avec interruption et conservez request_id pour l'assistance.

FAQ

Réponses courtes aux questions que nous voyons le plus dans les intégrations.

Combien de requêtes d'API puis-je exécuter ?

L'API est réservée aux entreprises. Le quota mensuel provient de votre forfait actif et des remplacements de clés. La graine Business par défaut est élevée et les administrateurs peuvent affiner chaque clé.

Puis-je envoyer des clés API dans le corps JSON ?

Oui. L'authentification basée sur l'en-tête est recommandée, mais les champs de corps de compatibilité apikey ou api_key sont également acceptés.

Puis-je créer des QR codes statiques avec l'API ?

Oui, mais le mode statique est limité aux chaînes WiFi. Utilisez le mode dynamique pour les URL, PDF, menus, apps, pages sociales et autres destinations gérées.

Les QR créés par l'API apparaissent-ils dans mon tableau de bord ?

Oui. Chaque création réussie est enregistrée dans votre compte et peut être gérée comme n'importe quel autre QR.

Que se passe-t-il lorsque j'atteins les limites ?

Vous recevez des erreurs JSON. Pour 429 réponses, respectez Retry-After et utilisez l'intervalle exponentiel avec gigue.

Puis-je supprimer un QR d'un autre compte ?

Non. La suppression et la liste sont limitées au propriétaire de la clé API authentifié.

Meilleures pratiques de sécurité

Ne jamais exposer les clés API brutes dans le JavaScript du navigateur, forfaits mobiles ou référentiels publics.
Utilisez les listes d'autorisation IP des clés API pour verrouiller l'utilisation sur des serveurs de confiance.
Consignez request_id avec vos propres ID de trace pour un tri plus rapide des incidents.
Faites pivoter les clés selon un calendrier et immédiatement après les fuites d'informations d'identification.

Ouvrir le gestionnaire de clés API

Automatisez la création de QR codes dynamiques avec l'API CreateQR

Démarrage rapide (cURL)

Authentification et compatibilité

Main Parameters

Paramètres de couleur et de forme

Paramètres du cadre

Créer des exemples de demande

Request Method:

Request URL:

Request Parameters:

Request Outcome

Request Method:

Request URL:

Request Parameters:

Request Outcome

Request Method:

Request URL:

Request Parameters:

Request Outcome

Request Method:

Request URL:

Request Parameters:

Request Outcome

Request Method:

Request URL:

Request Parameters:

Request Outcome

Request Method:

Request URL:

Request Parameters:

Request Outcome

Enveloppe de réponse de réussite

Request body

Response

Request body

Response

Enveloppe d'erreur typique

Stratégie de nouvelle tentative

Combien de requêtes d'API puis-je exécuter ?

Puis-je envoyer des clés API dans le corps JSON ?

Puis-je créer des QR codes statiques avec l'API ?

Les QR créés par l'API apparaissent-ils dans mon tableau de bord ?

Que se passe-t-il lorsque j'atteins les limites ?

Puis-je supprimer un QR d'un autre compte ?

Meilleures pratiques de sécurité