API de mise à jour des groupes de liens

Gérez et mettez à jour plusieurs liens courts en une seule opération grâce aux groupes.

Modifiez les paramètres au niveau du groupe pour mieux piloter vos campagnes, et mettez à jour en une fois des options comme la date d’expiration, le mot de passe ou les webhooks.

Toute modification du groupe s’applique à l’ensemble des liens qu’il contient.
En cas de conflit entre paramètres individuels et de groupe, les paramètres du groupe prévalent.

PUT

/api/link-group/v1/update

{
    "grpIdx": 5066,
    "nm": "Instagram Group",
    "memo": "A group of links used in Instagram ads.",
    "strtYmdt": "2026-03-01 00:00:00",
    "endYmdt": "2026-03-31 23:59:59",
    "expireUrl": "https://example.com/event-expired"
}

Request Parameters

grpIdx integer required
IDX du groupe.
Indiquez l’IDX du groupe à modifier.
nm string
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": null  // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}

Response Parameters

code integer
Code de réponse : 0 = Succès, autres valeurs = Erreur
message string
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
result string
Si webhookEnableYn est défini sur Y, une secret key est générée et renvoyée.
Si un webhookSecretKey existe déjà pour le groupe, aucune nouvelle clé ne sera générée ni renvoyée.

Quand utiliser cette API

Utilisez cette API lorsque la gestion individuelle de liens courts devient inefficace.

  • Désactiver plusieurs liens de campagne en une seule fois ou modifier leur période
  • Restreindre l’accès à tous les liens après la fin d’un événement
  • Appliquer les mêmes paramètres à plusieurs liens en une seule opération
La gestion par groupes réduit la charge opérationnelle par rapport aux modifications individuelles.

Fonctionnalités clés et impact des paramètres

Cette API ne se limite pas à des modifications, elle définit le comportement de vos liens.

Contrôle d’accès

  • Limiter l’accès aux utilisateurs non inscrits
  • Restreindre l’accès aux QR codes → accès réservé à certains utilisateurs

Analyse et filtrage

  • Exclure le trafic des bots → améliore la précision des données

Notifications

  • Notifications push et e-mail → réaction en temps réel

Planification

  • Définir les dates de début et de fin → activation/désactivation automatique

Gestion de l’expiration

  • Redirection après expiration → maintenir une bonne expérience utilisateur

Webhooks

  • Envoyer des données vers des serveurs externes → intégration et automatisation

Cas d’utilisation

  • Campagnes marketing : Désactiver tous les liens en fin de campagne et rediriger automatiquement vers une URL d’expiration
  • Plateformes SaaS : Regrouper les liens par fonctionnalité et gérer les accès et la disponibilité de façon centralisée
  • Gestion à grande échelle : Utiliser des webhooks pour synchroniser les clics avec les systèmes internes en temps réel
  • Sécurité : Renforcer la sécurité en renouvelant régulièrement les mots de passe

Points à considérer

  • Les modifications des paramètres de groupe s’appliquent immédiatement à tous les liens
  • Une mauvaise configuration des dates peut restreindre l’accès à tous les liens
  • L’envoi des webhooks peut être retardé selon la disponibilité du serveur externe
  • Modifier les filtres analytiques peut changer l’interprétation des données existantes