API de mise à jour des QR codes
Permet de mettre à jour la configuration et le design d’un QR code existant.
Vous pouvez modifier l’URL, le texte ou le numéro de téléphone, ainsi que les couleurs, styles, logos et autres options. Le QR code est mis à jour directement sans être recréé.
Utilisez cette API lorsque vous souhaitez modifier les paramètres sans générer un nouveau QR code.
/api/link/v1/update/qr
{
"linkId": "K56t",
"domain": "https://vvd.bz",
"type": "url",
"url": "https://www.instagram.com/vivoldiglobal",
"logoType": "U",
"logo": "https://example.com/images/picture/logo/20260425/500x500.png",
"foreground": "#0269D1FF"
}
Request Parameters
- linkId string required
-
ID du lien.
Si l’URL est « https://vvd.im/myBrandQR », l’ID du lien est
myBrandQR. - domain string required
- Default:https://vvd.bz
- Domaine du lien. Si vous utilisez un domaine personnalisé, vous pouvez le définir ici.
- type string
- Default:url
-
Enum:
urltextphone
-
Type de contenu du QR code.
- url : URL de page web
- text : Texte
- phone : Numéro de téléphone
- url string
-
URL de destination lors du scan.
Obligatoire si
type=url. Doit être une URL complète en http ou https.
Longueur maximale :2 000 bytes. - text string
-
Texte intégré dans le QR code.
Utilisé si
type=text. Affiché tel quel lors du scan.
Idéal pour messages, codes ou instructions. Le rendu peut varier selon l’appareil.
Longueur maximale :65 535 bytes. - phone string
-
Numéro de téléphone déclenché au scan.
Utilisé si
type=phone. Ouvre l’écran d’appel.
Maximum :32 caractères. Format international recommandé. - logoType string
- Default:N
-
Enum:
NCU
-
Type de logo au centre du QR code.
- N : Aucun logo
- C : Logo par défaut de l’organisation
- U : Logo personnalisé
Ajouter un logo renforce la reconnaissance de marque.
Disponible à partir du plan Personal. - logo string
-
URL de l’image du logo au centre du QR code.
Utilisé si
logoType=U. Doit être accessible publiquement.
Format carré recommandé, PNG transparent conseillé.
Taille maximale : 500x500 px. - foreground string
-
Couleur principale du QR code (HEX). Noir par défaut.
Assurez un contraste suffisant avec le fond.
Default : #000000FF - background string
-
Couleur de fond (HEX). Blanc par défaut.
Un fond trop sombre peut réduire la lisibilité.
Default : #FFFFFFFF - markerColor string
-
Couleur des marqueurs de position.
Default : #000000FF - markerBorderColor string
-
Couleur des bordures des marqueurs.
Default : #000000FF - style string
- Style visuel du QR code. Voir aperçu dans le dashboard.
- markerStyle string
- Style des marqueurs. Plusieurs formes disponibles.
- grpIdx integer
- Identifiant de groupe pour organiser les QR codes.
- ttl string
- Titre interne.
- memo string
- Note interne (non visible pour les utilisateurs).
- qrBypassYn string
-
Y : accès direct (sans tracking)
N : via lien court (tracking activé) - pushNotifyYn string
- Notification push lors du scan.
- mailNotifyYn string
- Notification email lors du scan.
- delYmdt datetime
- Date de suppression automatique.
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- Code de réponse : 0 = Succès, autres valeurs = Erreur
- message string
- Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
- result null
Quand utiliser cette API
Utilisez l’API de mise à jour des QR codes dans les cas suivants :
- Lorsque vous devez modifier l’URL de destination d’un QR déjà diffusé
- Lorsque vous souhaitez mettre à jour le design, comme les couleurs, logos ou styles
- Lorsque vous voulez modifier le contenu ou les paramètres sans supprimer le QR code
- Lorsque vous devez mettre à jour les QR à grande échelle, par exemple lors d’un rebranding
ce qui permet de modifier le contenu sans remplacer les QR déjà imprimés ou utilisés sur des supports offline.
Cas d’utilisation
L’API de mise à jour des QR codes s’adapte à de nombreux cas concrets :
- Supports imprimés et bannières : Modifier uniquement l’URL de destination des QR déjà diffusés pour éviter les coûts de réimpression
- Rebranding : Mettre à jour en masse le design des QR selon les nouvelles couleurs de marque
- Gestion d’événements : Changer les pages de destination selon les périodes sans modifier le QR
- Magasins et tables : Rediriger les QR existants vers de nouvelles pages de menu lors des changements
Idéal lorsque les QR codes déjà diffusés doivent être réutilisés.
Points à considérer
Tenez compte des éléments suivants lors de la mise à jour d’un QR code :
-
Modifiez
foreground(couleur principale) etbackground(couleur de fond) ensemble.
Modifier uniquement le fond peut réduire la fiabilité du scan en raison d’un contraste insuffisant. -
Utilisez un
backgroundclair, comme #FFFFFF (blanc).
Un fond sombre peut rendre le motif du QR difficile à détecter. - Lors de la modification de
type, fournissez le paramètre de données correspondant. - Changer le groupe avec
grpIdxdéplace le QR vers le nouveau groupe et le retire de l’ancien.