Créer un groupe de liens
API permettant de créer un groupe de liens.
Un groupe de liens permet d’organiser et de gérer plusieurs liens courts au sein d’un même groupe.
Lorsque le nombre de liens augmente, la gestion des paramètres de chaque lien individuellement peut devenir complexe.
En regroupant les liens, vous pouvez appliquer des paramètres tels que la date d’expiration, la limite de clics, le mot de passe, les notifications et les statistiques au niveau du groupe.
Les options configurées au niveau du groupe s’appliquent à tous les liens appartenant à ce groupe. Si des paramètres existent à la fois au niveau du lien et du groupe, les paramètres du groupe ont priorité.
Vous pouvez également organiser les liens par campagne, projet ou canal marketing, ce qui facilite l’analyse des performances et la gestion des liens à l’échelle du groupe.
L’identifiant du groupe généré peut être utilisé dans l’API de création de liens.
/api/link-group/v1/create
{
"nm": "Youtube Group",
"memo": "A group of links included in the description section of a YouTube video.",
"nonmemberSticsPwd": "123456"
}
Request Parameters
- nm string required
-
Nom du groupe.
Définit le nom du groupe utilisé pour organiser et gérer les liens. - memo string
-
Note interne pour la gestion du groupe.
Vous pouvez librement enregistrer l’objectif du groupe ou des informations de gestion. - notfSubscYn string
- Default:N
-
Enum:
YN
-
Définit si le lien est créé comme lien d’abonnement aux notifications push.
Y: crée un lien dédié à l’abonnement aux notifications push.
N: crée un lien standard.
Lorsqu’un utilisateur accède à ce lien, une demande d’abonnement aux notifications push du navigateur s’affiche. - qrBypassYn string
- Default:N
-
Enum:
YN
-
Définit le comportement de redirection lors d’un accès via un QR code.
Y: redirection directe vers l’URL d’origine. (Les statistiques de clic ne sont pas enregistrées)
N: redirection via l’URL courte. (Les statistiques de clic sont enregistrées) - blockOverseasSticsYn string
- Default:N
-
Enum:
YN
-
Définit si les accès depuis l’étranger sont exclus des statistiques.
Y: les accès internationaux ne sont pas inclus dans les statistiques.
N: les accès provenant de tous les pays sont inclus dans les statistiques. - pushNotifyYn string
- Default:N
-
Enum:
YN
-
Définit si des notifications push sont envoyées en fonction du nombre de clics.
Y: une notification push est envoyée lorsque le seuil défini est atteint.
N: aucune notification push n’est envoyée.
Cette fonctionnalité est disponible à partir de l’offre Personal. - mailNotifyYn string
- Default:N
-
Enum:
YN
-
Définit si des notifications par e-mail sont envoyées en fonction du nombre de clics.
Y: un e-mail est envoyé lorsque le seuil défini est atteint.
N: aucun e-mail n’est envoyé.
Cette fonctionnalité est disponible à partir de l’offre Personal. - nonmemberSticsPwd string
-
Mot de passe pour consulter les statistiques de clics en tant qu’utilisateur non inscrit.
Si vous souhaitez permettre aux utilisateurs non inscrits d’accéder aux statistiques, définissez le mot de passe requis pour accéder à la page de statistiques. - strtYmdt datetime
-
Date et heure de début de validité du lien.
Le lien devient accessible à partir de la date et de l’heure spécifiées.
Exemple:2026-03-01 00:00:00 - endYmdt datetime
-
Date et heure d’expiration du lien.
Après cette date, l’accès au lien est bloqué.
Exemple:2026-03-31 23:59:59 - expireUrl string
-
URL de redirection après l’expiration du lien.
Si aucune valeur n’est définie, une page d’information par défaut s’affiche.
Exemple:https://example.com/event-expired - pwd string
-
Mot de passe requis pour accéder au lien.
Si un mot de passe est défini, l’utilisateur devra le saisir avant d’accéder à la page de destination. - acesMaxCnt integer
-
Nombre maximal de clics autorisés.
Si cette limite est dépassée, l’accès au lien est bloqué. (0signifie aucune limite) - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Définit si les Webhooks sont activés.
Le Webhook global doit être activé au préalable.
Cette fonctionnalité est disponible uniquement dans l’offre Enterprise. - webhookCallbackUrl string
-
URL du serveur qui recevra les événements Webhook.
Ce champ est requis lorsquewebhookEnableYnest défini surY. Indiquez l’endpoint de votre serveur qui recevra les données d’événement.
Exemple:https://api.example.com/webhook - webhookMetric string
- Default:C
-
Enum:
CP
-
Critère déclenchant l’envoi du Webhook.
C: basé sur le nombre de clics, P: basé sur le nombre d’utilisateurs (clics uniques) - webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
-
Fréquence d’envoi des Webhooks.
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
{
"code": 0,
"message": "",
"result": {
"grpIdx": 5066, // group idx
"webhookSecretKey": null // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}
}
Response Parameters
- codeinteger
- Code de réponse : 0 = Succès, toute autre valeur = Erreur
- messagestring
- Message de réponse. Si le code n’est pas 0, un message d’erreur correspondant est renvoyé.
- resultobject
- grpIdx integer
- IDX du groupe.
- webhookSecretKey string
-
La secret key est renvoyée lorsque
webhookEnableYnest défini surY.