Créer un lien
Il s’agit de l’API de base pour créer des liens courts.
Pour générer plusieurs liens en une seule fois, utilisez l’API Bulk Create ou le menu [Créer des liens en masse] dans le tableau de bord.
Chaque lien court génère automatiquement un code QR.
- Les codes QR sont accessibles via https://vvd.bz/
[linkId]
/qr, et leur taille peut être ajustée avec le paramètre size. - Exemple : https://vvd.bz/hj7V/qr?size=200 → Renvoie un code QR de 200px.
POST
/api/link/v2/create
{
"url": "https://www.facebook.com/vivoldi365",
"domain": "https://vvd.bz"
}
Request Parameters
- urlstringrequired
- URL d’origine.
Jusqu’à 3 000 octets sont autorisés. - domainstringrequired
- Default:https://vvd.bz
- Domaine du lien.
Si l’option « brandLinkId » est définie surY
, le domaine serahttps://vvd.im
.
Un domaine personnalisé peut également être utilisé. - redirectTypeinteger
- Default:302
- Enum:200301302
- Type de redirection.
Voir la page Terminologie pour plus de détails.Cette fonctionnalité est disponible à partir du forfait Personnel.
- grpIdxinteger
- Utilisé pour regrouper les liens.
L’IDX de groupe peut être obtenu via l’API Liste de Groupes ou depuis le tableau de bord. - brandLinkIdstring
- Si aucune valeur n’est définie, l’ID du lien est généré automatiquement par le système.
Sans domaine personnalisé, le domaine par défaut esthttps://vvd.im
.
Exemple : https://vvd.im/[brandLinkId] - ttlstring
- Titre du lien. Si aucune valeur n’est précisée, le titre de la page web de l’URL d’origine sera utilisé.
Pour une création plus rapide, définissez directement cette valeur afin d’éviter un traitement inutile.
- descriptionstring
- Lorsque
redirectType
est200
, la meta-balise description peut être définie. - metaImgstring
- Lorsque
redirectType
est200
, la meta-balise image peut être définie.
L’URL de l’image doit commencer parhttps://
. - memostring
- Note pour la gestion du lien.
- notfSubscYnstring
- Default:N
- Enum:YN
- Indique s’il s’agit d’un lien d’abonnement push.
SiY
, une page de destination s’ouvre avant la redirection pour demander l’autorisation de notification.
Si l’utilisateur refuse ou annule, il est immédiatement redirigé vers l’URL d’origine. - pushNotifyYnstring
- Default:N
- Enum:YN
- Notifications push pour les clics.
SiY
, des alertes sont envoyées aux appareils avec l’application Vivoldi lorsqu’un seuil de clics défini est atteint (Tableau de bord → Paramètres).Cette fonctionnalité est disponible à partir du forfait Personnel.
- mailNotifyYnstring
- Default:N
- Enum:YN
- Notifications par e-mail pour les clics.
SiY
, un e-mail est envoyé chaque fois que le seuil de clics défini est atteint (Tableau de bord → Paramètres).Cette fonctionnalité est disponible à partir du forfait Personnel.
- delYmdtdatetime
- Date prévue de suppression du lien.
Après cette date, le lien est automatiquement supprimé.
Exemple : 2025-08-30 23:59:59
{
"code": 0,
"message": "",
"result": "https://vvd.bz/jH3d"
}
Response Parameters
- codeinteger
- Code de réponse : 0 = Succès, autres valeurs = Erreur
- messagestring
- Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
- resultstring
- Valeur de réponse. Le lien raccourci est renvoyé.
Exemple : https://vvd.bz/jH3d