API de liste des groupes de liens (v1)

Obtenez la liste des groupes de liens via API.

Filtrez par IDX ou nom du groupe et récupérez le grpIdx nécessaire pour créer, modifier ou supprimer des liens.

Documentation v1 (Legacy).

Pour les nouvelles intégrations, nous recommandons d’utiliser la version la plus récente, v2.
v1 est destinée à la maintenance des intégrations existantes et ne reçoit aucune nouvelle fonctionnalité ni amélioration.

GET

/api/link-group/v1/list?nm={nm} 

{
    "nm": "My+group"
}

Request Parameters

grpIdxinteger
Groupe de liens (IDX).
nmstring
Groupe de liens (Nom). La recherche partielle est prise en charge.
Si des espaces ou des caractères Unicode sont inclus, il est recommandé d’utiliser l’encodage URL. 
{
    "code": 0,
    "message": "",
    "result": [
        {
            "idx":1,
            "nm":"Amazon Electronics",
            "memo":"Products between $100 and $500",
            "linkCnt":112,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"N",
            "pushNotifyYn":"N",
            "mailNotifyYn":"N",
            "webhookEnableYn": "Y",
            "webhookCallbackUrl": "https://yourdomain.com/webhook/callback/vivoldi",
            "webhookMetric": "P",
            "webhookFrequency": 1,
            "regYmdt":"2024-07-20 02:30:00",
            "modYmdt":"2024-08-15 17:45:10"
        },
        {
            "idx":2,
            "nm":"XXX Advertiser Group",
            "memo":"2-year contract",
            "linkCnt":68,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"Y",
            "qrBypassYn":"N",
            "pushNotifyYn":"Y",
            "mailNotifyYn":"N",
            "webhookEnableYn": "N",
            "webhookCallbackUrl": null,
            "webhookMetric": "C",
            "webhookFrequency": 1,
            "regYmdt":"2024-07-20 02:42:00",
            "modYmdt":"2025-02-12 11:20:50"
        }
    ]
}

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é.
resultarray
idxinteger
Groupe IDX.
nmstring
Nom du groupe.
memostring
Note de gestion du groupe.
linkCntinteger
Nombre de liens dans le groupe.
notfSubscYnstring
Indique s’il s’agit d’un lien d’abonnement push.
qrBypassYn string
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)
pushNotifyYnstring
Indique si les notifications push de clics sont activées.
mailNotifyYnstring
Indique si les notifications par e-mail de clics sont activées.
webhookEnableYn string
Enum:
YN
Activation du Webhook.
webhookCallbackUrl string
URL de callback du Webhook.
webhookMetric string
Enum:
CP
Critère de réception du Webhook.
C : Basé sur le nombre de clics, P : Basé sur les utilisateurs uniques (clics uniques).
webhookFrequency integer
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.
regYmdtdatetime
Date de création.
modYmdtdatetime
Date de modification.