API de création de groupes de liens

Créez des groupes pour gérer vos liens courts de manière plus efficace.

Organisez les liens par catégorie, appliquez des paramètres en masse et conservez une structure claire.

Appliquez des paramètres communs comme la date d’expiration, le mot de passe, les webhooks et les limites de clics à plusieurs liens.

En cas de conflit entre paramètres individuels et de groupe, les paramètres du groupe prévalent.

POST

/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é. (0 signifie 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 lorsque webhookEnableYn est défini sur Y. 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 webhookEnableYn est défini sur Y.

Quand utiliser cette API

Cette API est idéale pour organiser et gérer efficacement plusieurs liens courts à grande échelle.

  • Regrouper les liens par catégorie pour une organisation claire
  • Distinguer les liens par campagne pour mieux analyser les performances
  • Gérer les liens par utilisateur ou par projet
  • Appliquer des paramètres à plusieurs liens en une seule opération
La gestion par groupes améliore la clarté et facilite le passage à l’échelle.

Quel est le rôle d’un groupe de liens ?

Un groupe de liens permet de gérer plusieurs liens courts comme une seule entité, pour une organisation claire et un contrôle simplifié.

  • Organiser et gérer les liens par groupe
  • Appliquer des paramètres communs comme les notifications et les restrictions d’accès
  • Distinguer les analyses et les indicateurs
  • Optimiser la gestion opérationnelle
Une fonctionnalité essentielle pour gérer efficacement des volumes importants de liens.

Cas d’utilisation

Cette API s’adapte à de nombreux scénarios d’utilisation.

  • Pages événementielles : Contrôlez l’accès sur une période définie avec strtYmdt·endYmdt
  • Liens internes : Protégez l’accès par mot de passe avec pwd
  • Liens avec webhook : Recevez des notifications instantanées lors d’un clic via webhookCallbackUrl
  • Autres : Organisez les liens par catégories de produits ou par client et équipe
Plus le volume de liens augmente, plus la gestion devient efficace.

Points à considérer

Vérifiez les points suivants avant de créer un groupe de liens.

  • Choisissez des noms de groupe clairs et cohérents avec votre organisation
  • Les paramètres du groupe peuvent affecter tous les liens qu’il contient
  • Une mauvaise configuration peut impacter vos opérations, soyez vigilant
  • Utilisez l’API de mise à jour des groupes pour effectuer des modifications si nécessaire
Une structure de groupes bien définie est essentielle pour une gestion efficace.