Documentation de l'API
Cette page utilise le même modèle de charge que le générateur de la page d'accueil et envoie des requêtes à https://qrkit.io/api/v1/qr/generate pour que vous puissiez tester le comportement de bout en bout en un seul endroit.
Types pris en charge
Champs pour URL
| Champ | Type | Requis |
|---|---|---|
| url | url | oui |
Exemple cURL
curl -X POST https://qrkit.io/api/v1/qr/generate \
-H "Content-Type: application/json" \
-d '{"type":"url","payload":{"url":"https://www.example.com"},"design":{"frame":{"enabled":false,"type":"none","text":"","fontFamily":"sans-serif","fontSize":34,"fontWeight":700,"textColor":"#ffffff","backgroundColor":"#000000","qrPadding":24,"paddingX":16,"paddingY":10,"borderRadius":12},"modules":{"shape":"square","color":"#000000","gradient":null},"background":{"color":"#ffffff","transparent":false},"finder":{"style":"square","centerStyle":"square","outerColor":"#000000","innerColor":"#000000","borderColor":"#000000"},"logo":{"enabled":false,"assetId":null,"sizePercent":20,"padding":0,"backgroundColor":"#ffffff","shape":"square","removeBackgroundBehindLogo":true},"quietZone":{"modules":2,"size":16}},"format":"svg","size":512,"errorCorrection":"M"}'Tester l'API de génération
Chargement...
Clés JSON de design prises en charge
L’exemple de design par défaut inclut désormais la structure complète de l’objet. Utilisez la référence ci-dessous pour comprendre quelles clés imbriquées vous pouvez remplacer dans `design`.
| Champ | Type | Exemple | Valeurs autorisées | Effet |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | Affiche un cadre CTA autour du code. |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | Sélectionne le preset du cadre CTA. |
| frame.text | string | "SCAN ME" | - | Libellé CTA affiché dans le cadre. |
| frame.fontFamily | string | "Space Grotesk" | - | Famille de police utilisée pour le texte CTA. |
| frame.fontSize | number | 34 | - | Contrôle l’échelle du texte CTA. |
| frame.fontWeight | number | 800 | - | Contrôle l’épaisseur du texte CTA. |
| frame.backgroundColor | string | "#0f172a" | - | Couleur de remplissage du cadre. |
| frame.textColor | string | "#ffffff" | - | Couleur du texte CTA. |
| frame.qrPadding | number | 24 | - | Espacement entre le QR et le cadre autour. |
| frame.paddingX | number | 16 | - | Marge intérieure horizontale du cadre CTA. |
| frame.paddingY | number | 12 | - | Marge intérieure verticale du cadre CTA. |
| frame.borderRadius | number | 12 | - | Arrondi des coins du cadre. |
| Champ | Type | Exemple | Valeurs autorisées | Effet |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | Définit la forme des modules QR. |
| modules.color | string | "#111827" | - | Couleur principale des modules. |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | Dégradé optionnel des modules. |
| modules.gradient.from | string | "#111827" | - | Couleur de départ du dégradé. |
| modules.gradient.to | string | "#10b981" | - | Couleur de fin du dégradé. |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | Direction du dégradé sur les modules QR. |
| background.color | string | "#ffffff" | - | Couleur d’arrière-plan du canevas. |
| background.transparent | boolean | false | - | Rend l’arrière-plan transparent. |
| Champ | Type | Exemple | Valeurs autorisées | Effet |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | Forme du repère externe. |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | Forme du centre du repère. |
| finder.outerColor | string | "#111827" | - | Couleur de l’anneau externe du repère. |
| finder.innerColor | string | "#0ea5e9" | - | Couleur du centre du repère. |
| finder.borderColor | string | "#111827" | - | Couleur d’accent de la bordure du repère. |
| quietZone.size | number | 24 | - | Marge de la zone calme autour du QR. |
| quietZone.modules | number | 4 | - | Contrôle de l’espacement basé sur les modules. |
| Champ | Type | Exemple | Valeurs autorisées | Effet |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | Active le rendu du logo. |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | Référence un asset logo téléversé via son ID. |
| logo.sizePercent | number | 18 | - | Taille du logo par rapport au corps du QR. |
| logo.padding | number | 6 | - | Espace supplémentaire autour du logo. |
| logo.shape | string | "circle" | circle, square | Choisit la forme du masque du logo. |
| logo.backgroundColor | string | "#ffffff" | - | Arrière-plan sous le logo. |
| logo.removeBackgroundBehindLogo | boolean | true | - | Supprime les modules QR derrière le logo. |
| logoDataUrl | string | "data:image/png;base64,..." | - | Data URL PNG/JPG/SVG inline pour afficher directement le logo. |