API de création de liens

Request Parameters

url string required

URL d’origine.
Jusqu’à 3 000 octets sont autorisés.

domain string required

Default:https://vvd.bz

Domaine du lien.
Si l’option « brandLinkId » est définie sur Y, le domaine sera https://vvd.im.
Un domaine personnalisé peut également être utilisé.

redirectType integer

Default:302

Enum:

200301302

Type de redirection.
Voir la page Terminologie pour plus de détails.
Cette fonctionnalité est disponible à partir du forfait Personnel.

reuseYn string

Par défaut :N

Enum :

YN

Indique si une URL existante doit être réutilisée.
Y : Si la même URL longue existe déjà, aucune nouvelle URL courte n’est créée — la première URL courte générée est renvoyée.
N : Une nouvelle URL courte est toujours créée.

Cette option est utilisée pour éviter les doublons d’URL longues ou réutiliser des liens existants.
Cette fonctionnalité est disponible uniquement pour les offres Premium et supérieures.

grpIdx integer

Utilisé pour regrouper les liens.
L’IDX de groupe peut être obtenu via l’API Liste de Groupes ou depuis le tableau de bord.

brandLinkId string

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 est https://vvd.im.
Exemple : https://vvd.im/[brandLinkId]

ttl string

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.

description string

Lorsque redirectType est 200, la meta-balise description peut être définie.

metaImg string

Lorsque redirectType est 200, la meta-balise image peut être définie.
L’URL de l’image doit commencer par https://.

memo string

Note pour la gestion du lien.

notfSubscYn string

Default:N

Enum:

YN

Indique s’il s’agit d’un lien d’abonnement push.
Si Y, 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.

qrBypassYn string

Par défaut :N

Enum :

YN

Contrôle s’il faut ignorer le lien court lors du scan d’un code QR et accéder directement à l’URL d’origine définie par l’utilisateur.
Y : Redirige directement vers l’URL d’origine sans passer par le lien court. (Les statistiques de scan QR ne sont pas enregistrées)
N : Passe par le lien court avant de rediriger vers l’URL d’origine. (Les statistiques de scan QR sont enregistrées)

pushNotifyYn string

Default:N

Enum:

YN

Notifications push pour les clics.
Si Y, 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.

mailNotifyYn string

Default:N

Enum:

YN

Notifications par e-mail pour les clics.
Si Y, 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.

webhookEnableYn string

Default:N

Enum:

YN

Activation du Webhook.
Le Webhook global doit être activé.
Cette fonctionnalité est disponible uniquement dans l’offre Enterprise.

webhookMetric string

Default:C

Enum:

CP

Critère de réception du Webhook.
C: Basé sur le nombre de clics, P: Basé sur le nombre d’utilisateurs uniques (clics uniques).

webhookFrequency integer

Default:1

Enum:

1501002003005001000

Fréquence de réception du Webhook.
1: À chaque clic, 50: Tous les 50 clics, 100: Tous les 100 clics, 300: Tous les 300 clics, 500: Tous les 500 clics, 1000: Tous les 1.000 clics.

delYmdt datetime

Date prévue de suppression du lien.
Après cette date, le lien est automatiquement supprimé.
Exemple : 2025-08-30 23:59:59