Developer API

Créer un lien

Cette API permet de créer une URL courte.
Pour générer plusieurs liens à la fois, utilisez l’API “Création en masse”.
Vous pouvez également créer rapidement des liens depuis le menu “Création de liens en masse” dans le tableau de bord.

Un code QR est automatiquement généré pour chaque lien court.
Il est accessible via l’URL suivante :
vvd.bz/[linkId]/qr

Pour ajuster la taille du code QR, ajoutez le paramètre size.
Exemple : vvd.bz/[linkId]/qr?size=200 → génère un code QR de 200 pixels

Http Header

POST /api/link/v2/create
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"url": "https://www.facebook.com/vivoldi365",
	"domain": "https://vvd.bz"
}

Domaines	Description des champs	Description	Type
url	URL longue	L’URL longue vers laquelle l’utilisateur sera redirigé lorsqu’il clique sur le lien court. Taille maximale: 3000 octets.	string
domain	Domaine	Si ce champ est vide, le domaine par défaut sera vvd.bz. Le champ doit inclure “https://”, et si l’option “brandLinkId” est “Y”, utiliser le domaine “https://vvd.im”. Si votre domaine est relié à Vivoldi, vous pouvez le définir ici. Exemple: https://vvd.bz	string
redirectType	Type de redirection	Définit comment la redirection se fait de l’URL courte vers l’URL longue. Valeurs possibles: 200, 301 ou 302 (HTTP). Valeur par défaut: 302 Pour plus de détails, voir la page “Glossaire”.	int
grpIdx	ID de groupe	Renseigner un ID de groupe permet d’associer le lien à ce groupe. Pour l’obtenir, utilisez l’API “Liste des groupes”.	int
brandLinkId	ID de lien de marque	Si une valeur est renseignée, le lien sera créé avec cet ID. (Si configuré, le domaine sera vvd.im et non vvd.bz.) Si vide, l’ID de lien est généré automatiquement.	string
ttl	Titre du lien	Si vide, le titre de la page web de l’URL longue sera utilisé. Si vide, Vivoldi analysera le HTML de l’URL longue, ce qui peut ralentir la réponse. Renseignez le titre si possible.	string
description	Méta description	Vous pouvez définir la méta description si “redirectType” vaut “200”. Ce champ est ignoré si “redirectType” est “301”, “302”, etc.	string
metaImg	Méta-image	Vous ne pouvez définir la balise méta-image que lorsque la valeur de redirectType est « 200 ». La valeur méta-image doit être au format URL commençant par « https:// ». Si redirectType est « 301 » ou « 302 », la valeur est ignorée.	string
memo	Notes	Vous pouvez ajouter des informations supplémentaires pour la gestion, non visibles par les utilisateurs.	string
notfSubscYn	Lien Push	Si la valeur est Y, une fenêtre de notification push s’affichera avant la redirection, et vous pourrez envoyer des notifications à tous les utilisateurs qui l’autorisent. Si l’utilisateur refuse ou ferme la fenêtre, il est redirigé vers l’URL longue. Par défaut (si vide), la valeur est N. Pour plus d’informations, consultez la page dédiée Web Push.	Y ou N
pushNotifyYn	Notifications push	Si Y, vous recevrez une notification push sur mobile (avec l’app Vivoldi) à chaque fois que le nombre de clics configuré dans “Préférences” est atteint. Disponible à partir du forfait Personnel.	Y ou N
mailNotifyYn	Notifications e-mail	Si Y, vous recevrez un e-mail chaque fois que le seuil de clics défini dans les préférences du lien est atteint. Disponible à partir du forfait Personnel.	Y ou N
delYmd	Date de suppression du lien	Après la date renseignée, le lien est automatiquement supprimé par le système. Cycle de suppression: chaque heure Exemple: 2025-12-31	Date

Response

{
	"code": 0,
	"message": "",
	"result": "https://vvd.bz/jH3d"
}

Domaines	Description	Type
code	Code de réponse (0:Succès)	int
message	Le message de réponse, ou un message connexe si le code de réponse est différent de zéro.	string
result	Valeur de la réponse (lien abrégé)	string