API de liste des groupes de liens (v2)

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.

GET

/api/link-group/v2/list?nm={nm}&pages={pages} 


GET /api/link-group/v2/list
     ?nm=My+group
     &pages=1

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": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "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

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 object
extra object
Informations sur la page et le nombre de données.
pages integer
Numéro de la page actuelle
nextPages integer
Numéro de la page suivante
nextYn string
Indique s’il existe une page suivante
count integer
Nombre d’enregistrements sur la page actuelle
totalCount integer
Nombre total d’enregistrements
list array
Informations sur le groupe
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.

Quand utiliser cette API

Utilisez cette API lorsque vous avez besoin d’un ID de groupe (grpIdx) pour créer ou mettre à jour des liens.

Elle est utile lorsque le tableau de bord n’est pas accessible ou lorsque des scripts automatisés doivent récupérer les IDs dynamiquement.

Chargez tous les groupes pour créer des menus déroulants ou recherchez des groupes spécifiques pour vérifier leur état.
Au-delà d’une simple requête, elle constitue souvent le point de départ du flux de gestion des liens.

Utilisation des filtres

Passez grpIdx pour récupérer un groupe spécifique.
Le paramètre nm prend en charge la recherche partielle, ce qui permet d’obtenir des résultats avec une partie du nom.

Si le nom contient des espaces ou des caractères Unicode, appliquez le URL encoding pour garantir des résultats précis.

Structure de réponse et utilisation

이 API는 페이지 기반 구조화된 데이터를 반환합니다.
조회 결과는 단순 출력이 아니라 후속 API와 연결되는 기준 데이터로 사용됩니다.

페이지 정보 (extra)

  • pages → 현재 페이지
  • nextPages → 다음 페이지 존재 여부
  • count → 현재 페이지 데이터 수
  • totalCount → 전체 그룹 수

대량 데이터 처리 시 반복 조회 로직 구성 기준이 됩니다.

설정 정보 포함 구조

응답에는 그룹의 운영 설정도 함께 포함됩니다.

예:

  • 접근 제어 (notSubscYn, qrBypassYn)
  • 알림 (pushNotifyYn, mailNotifyYn)
  • Webhook (webhookEnableYn, webhookCallbackUrl)
  • totalCount → 전체 그룹 수

별도 조회 없이 현재 상태를 즉시 파악 가능합니다.

Cas d’utilisation

  • Pipeline automatisé : Récupérer la liste des groupes avant de créer des liens pour obtenir grpIdx
  • Interface de gestion : Charger tous les groupes et les afficher comme options dans un menu déroulant
  • Recherche ciblée : Saisir une partie du nom dans nm pour filtrer rapidement les groupes
  • Pagination : Incrémenter pages pour parcourir l’ensemble des groupes

Points à considérer

  • Si le paramètre nm contient des espaces ou des caractères Unicode, appliquez le URL encoding.
    Sans encodage, les résultats peuvent être imprécis.
  • pages indique le numéro de page et commence à 1.
    Si nextYn vaut N, il s’agit de la dernière page et vous pouvez arrêter l’itération.
  • La valeur idx dans la réponse correspond au grpIdx utilisé dans les APIs de création, mise à jour et suppression.
    Veillez à ne pas les confondre.