Documentation de l'API PartnerBoost
Intégrez vos systèmes à la plateforme de gestion des partenariats PartnerBoost. Notre API vous permet de gérer les transactions, de générer des rapports, de traiter les créations publicitaires et de gérer votre flux de données produits de manière programmatique.
Brand AI
Présentation générale
Les fonctionnalités « PartnerBoost » destinées aux marchands ont été officiellement intégrées à la plateforme OpenClaw. En tirant parti des capacités « intelligence artificielle + exploitation automatisée » d’OpenClaw, elles offrent aux marchands du commerce électronique transfrontalier des services opérationnels basés sur l’IA, fonctionnant à la manière d’un employé numérique. Les commerçants peuvent rapidement effectuer des requêtes sur les données de commande, analyser les performances, évaluer l’efficacité des canaux, vérifier les factures, gérer les médias des partenaires et réaliser d’autres opérations simplement à l’aide d’instructions en langage naturel, sans avoir à se connecter manuellement à l’interface d’administration pour exporter des rapports. Cela améliore considérablement l’efficacité des opérations de marketing d’affiliation et permet de passer d’une gestion manuelle à une interaction intelligente.
Guide - OpenClaw
OpenClaw Skill 安装指引
一、获取 API Key
在开始查询前，请先准备好 PARTNERBOOST_API_KEY：
- 主账号：登录 PartnerBoost（PB）平台，在「设置」或「API 管理」页面直接查看并复制 API Key。
- 子账号：联系主账号管理员，在 PB 平台内为你分配 API Key。
二、创建飞书企业应用
- 进入飞书开放平台：https://open.feishu.cn/app
-
点击创建企业自建应用，按指引完成基础创建流程。
-
左侧菜单栏点击添加应用能力，在右侧找到机器人并点击「添加」。
-
左侧菜单栏点击凭证与基础信息，复制 App ID 及 App Secret 备用。
三、在阿里云创建 OpenClaw 实例
-
阿里云搜索「OpenClaw」，进入购买页面：https://www.aliyun.com/benefit/scene/openclaw
-
选择适配配置，完成购买。
-
等待实例创建完成，点击管理 OpenClaw。
-
依次完成 OpenClaw 使用步骤 1→2→3，填入飞书应用的 App ID 和 App Secret。
四、安装 PartnerBoost Brand Skill
- 打开飞书，搜索并找到已创建的 OpenClaw 应用机器人。
-
发送以下指令（将
PARTNERBOOST_API_KEY替换为你的实际 Key）：帮我安装这个技能 https://github.com/partnerboost-tech-team/partnerboost-brand 然后初始化他，我的key是 PARTNERBOOST_API_KEY
- 等待机器人提示技能安装成功。
-
发送指令重启，重启 OpenClaw 使配置生效。
- 重启完成后即可正常使用，支持查询订单、合作媒体、业绩数据等功能。
PartnerBoost OpenClaw Skill Installation Guide
Content generated by AI1. Obtain Your API Key
Before starting, ensure you have your PARTNERBOOST_API_KEY ready:
- Primary Account: Log in to the PartnerBoost (PB) platform. Go to the "Settings" or "API Management" page to view and copy your API Key.
- Sub-Account: Contact your primary account administrator to have an API Key assigned to you within the PB platform.
2. Create a Discord Bot
- Go to the Discord Developer Portal: https://discord.com/developers/applications
- Click "New Application", enter a name, and create it.
-
Navigate to the "Bot" tab in the left sidebar:
- Click "Reset Token" to generate your Bot Token. (Copy and save it immediately; it will not be shown again).
- Under the "Privileged Gateway Intents" section, toggle ON the
MESSAGE CONTENT INTENT(This is required for the bot to read your commands).
-
Navigate to "OAuth2" → "URL Generator":
- Scopes: Select
bot. - Bot Permissions: Select
Administrator(or specific messaging permissions). - Copy the generated URL, paste it into your browser, and invite the bot to your Discord server.
- Scopes: Select
- Go to "General Information" and copy the Application ID (Client ID) for later use.
3. Create an OpenClaw Instance on AWS
- Log in to the AWS Management Console and navigate to the EC2 dashboard.
-
Launch Instance:
- Name:
OpenClaw-Server. - OS (AMI): Select
Ubuntu 22.04 LTS(Recommended). - Instance Type: Select
t3.medium(2 vCPU, 4GB RAM) or higher. - Security Group: Ensure ports TCP 80, 443, and the specific OpenClaw WebUI port are open.
- Name:
-
Deploy OpenClaw:
- Connect to your instance via SSH and install Docker.
- Pull and run the OpenClaw image.
-
Initialization:
- Access the OpenClaw WebUI via your instance's Public IP in a browser.
- Enter your Discord Bot Token and Application ID during the setup steps.
- Complete the basic configuration and dashboard initialization.
4. Install PartnerBoost Brand Skill
- Open Discord and go to the server where your OpenClaw bot is present.
-
Send the following command to the bot (Replace
[YOUR_API_KEY]with your actual key):Command:
Please install this skill https://github.com/partnerboost-tech-team/partnerboost-brand and initialize it. My key is [YOUR_API_KEY] - Wait for the bot to reply: "Skill installation successful."
- Send the command
restartto apply the changes. - Once restarted, the bot is ready. You can now query orders, affiliate partners, and performance data.
Cas d'utilisation
Cas d'utilisation n° 1 : Évaluation des performances et optimisation de l'affectation
Exemple d'instruction : Examinez les données relatives aux commandes PB des trois derniers mois et formulez des suggestions pour optimiser le placement des commandes.
Fonctionnalité IA : extrait automatiquement les données relatives aux commandes → analyse le retour sur investissement (ROI) sur l'ensemble des canaux → identifie les supports à fort taux de conversion → formule des recommandations pour l'ajustement des commissions et l'optimisation du placement.
Cas d'utilisation n° 2 : Suivi des commandes en temps réel
Exemple d'instruction : Quels sont les résultats des commandes récentes ? Présentez un résumé des canaux les plus performants.
Fonctionnalité IA : compile les indicateurs clés relatifs aux commandes → signale les commandes anormales (remboursements, transactions suspectes) → génère une liste de canaux de haute qualité.
Cas d'utilisation n° 3 : Consultation rapide d'une facture
Exemple d'instruction : Vérifie ma facture du mois dernier.
Fonctionnalité IA : récupère directement les factures du mois sélectionné → affiche les détails des commissions et l'état de règlement sans avoir à se connecter à l'interface d'administration.
Cas d'utilisation n° 4 : Gestion des médias partenaires
Exemple d'instruction : Avec quels supports promotionnels suis-je actuellement en partenariat ?
Fonctionnalité IA : répertorie tous les supports promotionnels des partenaires et affiche clairement la structure des ressources.
FAQ
Q1 : Qui peut utiliser PartnerBoost Skills ?
R : Tous les commerçants ayant intégré PartnerBoost peuvent l'activer.
Q2 : Quelles données l'IA peut-elle interroger ?
R : Il prend en charge les données opérationnelles essentielles telles que les données relatives aux commandes, le volume des ventes, le taux de conversion, les performances des canaux de distribution, les détails de facturation et les supports des partenaires.
Q3 : Comment la sécurité des données est-elle assurée ?
R : Tous les accès aux données et toutes les opérations sont effectués dans le cadre de l'autorisation accordée au commerçant, conformément aux normes de sécurité de la plateforme, et aucune donnée commerciale ne sera divulguée.
Q4 : À part interroger des données, que peut faire d'autre l'IA ?
R : Il est capable d'analyser automatiquement les données, de proposer des suggestions de placement et de surveiller les commandes anormales. À l'avenir, il permettra notamment de créer des campagnes, de sélectionner des influenceurs et de générer des supports marketing.
Q5 : Que se passe-t-il si la configuration échoue ou si la fonctionnalité n'est pas disponible ?
R : Veuillez vérifier que vous êtes bien connecté à ClawHub et que vous avez correctement ajouté les compétences PartnerBoost. Si le problème persiste, contactez le service client de PartnerBoost ou votre chargé de compte.
API de marque
Authentification
L'API PartnerBoost prend actuellement en charge plusieurs actions différentes. Toutes les requêtes doivent être envoyées sous forme de requêtes GET ou POST (JSON) via HTTPS à l'adresse suivante :
https://app.partnerboost.com/api/brand
Paramètres obligatoires
offre- Le numéro d'identification de votre marquejeton- Jeton unique attribué lors de la configuration du compte pour l'utilisation de l'APIaction- L'une des actions prises en chargeversion- Version actuelle : 1.0
En-têtes obligatoires
Type de contenu- application/jsonX-PARTNERBOOST-DATE- La date du jour en UTC (temps universel coordonné)X-PARTNERBOOST-AUTHENTICATION- Le hachage d'authentification calculé
Hachage d'authentification
Le hachage d'authentification est un hachage SHA-256 au format hexadécimal de 64 caractères correspondant à la chaîne de caractères suivante :
VotreJetonAPI ; ValeurDeL'ActionAPI ; DateActuelleAuFormatUTC ; VotreCléSecrèteAPI
Exemple
Pour les valeurs suivantes :
- Action API : order/new
- Jeton : a25fb1225425ae360ec2922286e7bd01
- Clé secrète API : 65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
- Date UTC : vendredi 7 janvier 2022, 07:21:16 GMT
- Chaîne vers hachage : a25fb1225425ae360ec2922286e7bd01 ; commande/nouvelle ;ven., 07 janv. 2022 07:21:16 GMT;65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
En-têtes HTTP corrects
- X-PARTNERBOOST-DATE : vendredi 7 janvier 2022, 07:21:16 GMT
- X-PARTNERBOOST-AUTHENTICATION : c0603ea2f4bd66eaac5e6fbbd2093ea6426d7e13e0a8cc4f5550368f55f7e64a
API de transaction
PUBLIER
commande/nouvelle
Créer une nouvelle transaction
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
numéro_de_commande |
Votre numéro de commande unique | 201000000001 | Oui | chaîne de caractères |
pbtid |
Code de la piste de clic PartnerBoost | x_xxxxx | Non | chaîne de caractères |
is_new_customer |
S'agit-il d'un nouveau client de la marque ? | false | Non | bool |
uid |
L'identité de l'utilisateur au sein de la marque | 453215 | Non | chaîne de caractères |
devise |
Devise de la commande | USD | Oui | chaîne de caractères |
trans_time |
Délai de traitement de la commande | Jeudi 20 janvier 2022, 05 h 27 min 30 s GMT | Oui | chaîne de caractères |
montant |
Montant réel de la commande | 111.55 | Non | double |
quantité |
Quantité de produits | 1 | Non | int |
remarque |
N'importe quel message | Non | chaîne de caractères | |
code promo |
Liste de codes promotionnels séparés par des virgules | ZVKD234, ZVKA111 | Non | chaîne de caractères |
skus |
Liste des références (obligatoire lorsque la commande comporte des références) | Tableau | Non | tableau |
Demander une démonstration
{
"order_number": "RMD17ea9a09be7c4bd4101aa3d21df80b47",
"currency": "CNY",
"trans_time": "Thu, 20 Jan 2022 05:27:30 GMT",
"pbtid": "ldc_xdw3",
"skus": [
{
"id": "1df80b47",
"name": "Mi book",
"amount": 2776,
"quantity": 12
}
]
}
Démonstration de la réponse
{
"code": 0,
"data": "210120052732256X22",
"msg": "success"
}
POST
commande/annulation
Transaction annulée
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
numéro_de_commande |
Votre numéro de commande unique | 201000000001 | Oui | chaîne de caractères |
Demander une démonstration
{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}
Démonstration de la réponse
{
"code": 0,
"data": "",
"msg": "success"
}
POST
commande/entrée en vigueur
Transaction effective
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
numéro_de_commande |
Votre numéro de commande unique | 201000000001 | Oui | chaîne de caractères |
Demander une démonstration
{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}
Démonstration de la réponse
{
"code": 0,
"data": "",
"msg": "success"
}
POST
commande/bonus
Attribuer un bonus à l'éditeur
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
medium_id |
Identité de l'éditeur | LDC000123 | Oui | chaîne de caractères |
devise |
Devise de la commande | USD | Oui | chaîne de caractères |
trans_time |
Délai de traitement de la commande | Jeudi 20 janvier 2022, 05 h 27 min 30 s GMT | Oui | chaîne de caractères |
commission |
Commission versée à l'éditeur | 11.15 | Oui | double |
remarque |
N'importe quel message | Non | chaîne de caractères |
Demander une démonstration
{
"medium_id": "LDC0012346",
"currency": "CNY",
"trans_time": "Thu, 20 Jan 2022 05:27:30 GMT",
"commission": 416.4
}
Démonstration de la réponse
{
"code": 0,
"data": "210120052732256X22",
"msg": "success"
}
API de rapports
PUBLIER
rapport/liste_des_clics
Liste des clics
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
heure_de_début |
Horodatage de début | 1650351153 | Non | int |
end_time |
Horodatage de fin | 1670351153 | Non | int |
d'abord |
Tout d'abord | 0 | Non | int |
taille_de_page |
Taille de la page : de 20 à 100 | 20 | Non | int |
identifiant_éditeur |
Identifiant de l'éditeur | Non | chaîne de caractères | |
channel_id |
Identifiant de chaîne | Non | chaîne de caractères |
Demander une démonstration
{
"first": 720078
}
Démonstration de la réponse
{
"code": 0,
"data": {
"pageInfo": {
"hasNextPage": true,
"endCursor": "720131",
"startCursor": "720107"
},
"list": [
{
"id": "720107",
"pbtid": "pb_xxt0",
"ip": "217.143.18.13",
"location": "CA",
"referer": "https://example.com",
"usource": "PC",
"useragent": "Mozilla/5.0...",
"publisher_id": "50153",
"publisher_name": "meimei",
"channel_id": "4493",
"channel_name": "yuyao",
"landing_page": "",
"created_timestamp": "1648692632",
"created_time": "Thu, 31 Mar 2022 02:10:32 GMT"
}
]
},
"msg": "success"
}
PUBLIER
rapport/détails_clics
Détails des clics
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
id |
Identifiant de transfert (l'un des deux identifiants « id » et « pbtid » est obligatoire) | 720078 | Non | int |
pbtid |
Indicateur de suivi provenant de l'URL de destination (l'un des deux, id ou pbtid, est obligatoire) | pb_xxxx | Non | chaîne de caractères |
Demander une démonstration
{
"id": 720112
}
Démonstration de la réponse
{
"code": 0,
"data": {
"id": "720107",
"pbtid": "pb_xxt0",
"ip": "217.143.18.13",
"location": "CA",
"referer": "https://app.partnerboost.com/publisher/payments/transaction_inquiries?act=new",
"usource": "PC",
"useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.60 Safari/537.36",
"publisher_id": "50153",
"publisher_name": "meimei",
"channel_id": "4493",
"channel_name": "yuyao",
"landing_page": "",
"created_timestamp": "1648692632",
"created_time": "Thu, 31 Mar 2022 02:10:32 GMT"
},
"msg": "success"
}
PUBLIER
rapport/liste_des_commandes
Liste des commandes
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
heure_de_début |
Horodatage de la transaction | 1650351153 | Non | int |
end_time |
Horodatage de la transaction | 1670351153 | Non | int |
numéro de page |
Numéro de page | 1 | Non | int |
taille_de_page |
Taille de la page : de 20 à 100 | 20 | Non | int |
sort_dir |
enum(desc, asc), la valeur par défaut est « desc » | desc | Non | énumération |
sort_col |
enum(transid, commission, montant) | transid | Non | énumération |
statut |
enum(new, void, effective) | Non | énumération | |
type |
Type de transaction | Non | énumération |
Demander une démonstration
{
"status": "effective"
}
Démonstration de la réponse
{
"code": 0,
"msg": "success",
"data": {
"total": "1",
"list": [
{
"id": "316",
"order_id": "12123121",
"publisher_id": 50034,
"channel_id": 4480,
"coupon_code": "",
"transaction_type": "trans",
"status": "effective",
"transaction_time": "Wed, 20 Apr 2022 08:04:23 GMT",
"transaction_timestamp": 1650441863,
"track_code": "",
"currency": "USD",
"sale_amount": 135.7,
"network_fee": 3.05,
"commission": 20.35,
"total_spend": 23.4,
"ori_currency": "CNY",
"ori_sale_amount": 864.36,
"ori_network_fee": 19.44,
"ori_commission": 129.65,
"ori_total_spend": 149.09,
"skus": [
{
"sku": "b219ac3d",
"status": "effective",
"quantity": 12,
"commission_id": "0",
"currency": "USD",
"sale_amount": 68.64,
"network_fee": 1.54,
"commission": 10.29,
"total_spend": 11.83,
"ori_currency": "CNY",
"ori_sale_amount": 437.22,
"ori_network_fee": 9.83,
"ori_commission": 65.58,
"ori_total_spend": 75.41
}
]
}
]
}
}
POST
rapport/liste_des_transactions
Liste des transactions
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
limite |
Nombre par page (max. 200, par défaut 100) | 100 | Non | int |
curseur |
Curseur de pagination | 1 | Oui | chaîne de caractères |
date_de_début |
Date de début (AAAAMMJJ) | 20241101 | Non | chaîne de caractères |
date_fin |
Date de fin (AAAAMMJJ) | 20241101 | Non | chaîne de caractères |
statut_de_la_commande |
État de la commande | nouveau, nul, mixte, verrouillé, payé | Non | chaîne de caractères |
sku_status |
Statut du SKU/ASIN | nouveau, nul, verrouillé, payé | Non | chaîne de caractères |
type_de_transaction |
Type de transaction | bonus, ajouté manuellement, normal | Non | chaîne de caractères |
identifiant_éditeur |
Identifiant de l'éditeur | Non | chaîne de caractères | |
group_id |
Identifiant de groupe attribué aux éditeurs | 323 | Non | chaîne de caractères |
Demander une démonstration
{
"limit": 100,
"cursor": "1",
"start_date": "20241101",
"end_date": "20241130",
"order_status": "locked"
}
Démonstration de la réponse
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"order_id": "C1TZX-95VVFA5R95",
"order_status": "locked",
"date": "2024-11-07 05:00:00",
"currency": "USD",
"publisher_id": "180716",
"publisher_name": "haar1",
"sku_list": [
{
"sku_status": "locked",
"sku": "B0CJM2W42K",
"quantity": "2",
"sales_amount": "100.00",
"commission": "27.00"
}
]
}
],
"count": 1,
"cursor": null
}
}
API créative
POST
création/liste
Liste créative
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
type |
Type | IMAGE/TEXTE/COUPON | Oui | chaîne de caractères |
statut |
Statut | Prévu / Actif / Expiré | Non | Tableau |
vie privée |
Autorisation | PUBLIC/PRIVÉ | Non | Tableau |
mot-clé |
Mot-clé | test | Non | chaîne de caractères |
page_num |
Numéro de page | 1 | Non | int |
taille_de_page |
Taille de la page | 10 | Non | int |
Demander une démonstration
{
"type": "IMAGE",
"status": ["Active"],
"privacy": ["PUBLIC"],
"keyword": "test",
"page_num": 1,
"page_size": 10
}
Démonstration de la réponse
{
"data": {
"total_size": 1,
"total_page": 1,
"page_size": 28,
"page_num": 1,
"current_size": 1,
"data": [
{
"id": "132505",
"mid": "partnerboost",
"start_time": "1680241332",
"end_time": "1682574132",
"title": "test",
"privacy": "PUBLIC",
"type": "IMAGE",
"category": "cate",
"link": "https://www.example.com",
"created_time": "1679636639",
"updated_time": "1679636659",
"deleted_time": "0",
"is_deleted": "0",
"status": "Active",
"images": [
{
"creative_id": "132505",
"image_url": "https://example/img.png",
"width": "2880",
"height": "1800",
"alternate": "",
"size": "957112"
}
]
}
]
},
"code": 0,
"message": "ok"
}
PUBLIER
création/créer
Télécharger une création
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
type |
Type | IMAGE/TEXTE/COUPON | Oui | chaîne de caractères |
heure_de_début |
Heure de début | 1680241332 | Oui | chaîne de caractères |
end_time |
Heure de fin | 1682574132 | Oui | chaîne de caractères |
lien |
Lien (obligatoire lorsque type == TEXT) | https://www.example.com | Non | chaîne de caractères |
contenu |
Contenu (obligatoire lorsque type == TEXT) | test | Non | chaîne de caractères |
images |
Images (obligatoires lorsque type == IMAGE) | Tableau | Non | Tableau |
titre |
Titre | test | Non | chaîne de caractères |
vie privée |
Confidentialité | PUBLIC/PRIVÉ | Non | chaîne de caractères |
Demander une démonstration
{
"title": "bnane",
"category": "cate",
"privacy": "PUBLIC",
"site_ids": [],
"start_time": 1681282362,
"end_time": 1683874362,
"type": "TEXT",
"images": [
{
"width": 225,
"height": 225,
"url": "https://cdn-test.55haitao.com/data/upload/image/20230412/20230412160510_94131.jpeg",
"size": 10500
}
],
"link": "http://example.com",
"highligh": [],
"preview": null,
"content": "test"
}
Démonstration de la réponse
{
"code": 0,
"data": [
132508
],
"msg": "success"
}
PUBLIER
créer/modifier
Modifier la création
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
id |
ID | 132505 | Oui | chaîne de caractères |
titre |
Titre | test | Non | chaîne de caractères |
heure_de_début |
Heure de début | 1680241332 | Non | chaîne de caractères |
end_time |
Heure de fin | 1682574132 | Non | chaîne de caractères |
vie privée |
Confidentialité | PUBLIC/PRIVÉ | Non | chaîne de caractères |
Demander une démonstration
{
"id": "132505",
"title": "test",
"category": "cate",
"privacy": "PUBLIC",
"start_time": "1680241332",
"end_time": "1682574132"
}
Démonstration de la réponse
{
"code": 0,
"data": null,
"msg": "success"
}
API Datafeed
POST
flux_de_données/obtenir_des_informations
Obtenir des informations sur le flux de données
Demander une démonstration
{}
Démonstration de la réponse
{
"code": 0,
"data": {
"last_updated": "1653546984",
"last_uploaded_time": "1653466305",
"max_upload_num_per_month": "10",
"num_products": "9",
"fetch_url": "http://www.yousite.com/datafeed.xml",
"fetch_period": "DAILY",
"last_fetch_time": "1653552418",
"last_fetch_status": "XML parse error",
"updated_time": "1653882623",
"parsing_files_num": 0,
"uploaded_this_month": 8
},
"msg": "success"
}
POST
flux_de_données/mise_à_jour_des_paramètres
Mettre à jour les paramètres du flux de données
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
période_de_récupération |
Périodicité de récupération (JAMAIS, QUOTIDIENNE, HEBDOMADAIRE, MENSUELLE) | QUOTIDIEN | Oui | chaîne de caractères |
fetch_url |
Récupérer l'URL | http://www.yousite.com/datafeed.xml | Oui | chaîne de caractères |
Demander une démonstration
{
"fetch_period": "DAILY",
"fetch_url": "http://www.yousite.com/datafeed.xml"
}
Démonstration de la réponse
{
"code": 0,
"data": null,
"msg": "success"
}
POST
flux_de_données/mise_à_jour_produit
Mettre à jour ou ajouter un produit
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
nom |
Nom du produit | Nom du produit | Oui | chaîne de caractères |
url |
URL du produit | http://www.yousite.com/product/1 | Oui | chaîne de caractères |
image |
Image du produit | http://www.yousite.com/product/1.jpg | Oui | chaîne de caractères |
référence |
Référence produit (unique) | Référence | Oui | chaîne de caractères |
prix |
Prix du produit | 100 | Oui | nombre |
devise |
Code de devise (ISO 4217) | USD | Oui | chaîne de caractères |
description |
Description du produit | Description du produit | Non | chaîne de caractères |
catégorie |
Catégorie de produits | Catégorie | Non | chaîne de caractères |
ancien_prix |
Ancien prix du produit | 100 | Non | nombre |
marque |
Marque du produit | Marque | Non | chaîne de caractères |
gtin |
Numéro d'identification commercial mondial | 9783161484100 | Non | chaîne de caractères |
mpn |
Référence fabricant | CR2032 | Non | chaîne de caractères |
disponibilité |
Disponibilité des produits | En stock | Non | chaîne de caractères |
Demander une démonstration
{
"name": "Product Name",
"description": "Product Description",
"url": "http://www.yousite.com/product/1",
"image": "http://www.yousite.com/product/1.jpg",
"sku": "SKU",
"category": "Category",
"price": 100,
"currency": "USD",
"old_price": 100,
"brand": "Brand",
"gtin": "9783161484100",
"mpn": "CR2032",
"availability": "In Stock"
}
Démonstration de la réponse
{
"code": 0,
"data": "Added",
"msg": "success"
}
API Éditeur
PUBLICATION
éditeur/liste
Liste des éditeurs
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
identifiant_éditeur |
Identifiant de l'éditeur | 9527 | Non | int |
channel_id |
Identifiant de chaîne | 9527 | Non | int |
statut |
Statut | a rejoint | Non | chaîne de caractères |
Demander une démonstration
{
"publisher_id": 9527,
"apply_status": "joined",
"channel_id": 9527
}
Démonstration de la réponse
{
"code": 0,
"msg": "success",
"data": [
{
"publisher_id": "109271",
"publisher_name": "aaa_bai",
"description": "",
"channel_list": [
{
"medium_id": "PB00040837",
"channel_id": "40837",
"status": "adopt",
"title": "s1",
"host": "http://s1.host",
"word": ",2123,2413213",
"userid": "109271",
"c_id": "",
"c_category_id": "6"
}
],
"keywords": [
"2123",
"2413213",
"s2",
"s4"
],
"category": [
"Food & Drink"
],
"promotion_method": []
}
]
}
PUBLICATION
éditeur/maintenance
Éditeur et maintenance
| Clé | Titre | Exemple | Obligatoire | Type |
|---|---|---|---|---|
identifiant utilisateur |
Identifiant utilisateur (L'un des champs « userId » et « site_ids » est obligatoire) | 40828 | Oui | chaîne de caractères |
identifiants_de_site |
Identifiants de site (l'un des champs « userId » et « site_ids » est obligatoire) | 40828 | Oui | chaîne de caractères |
mail_id |
Identifiant de messagerie | 40828 | Non | chaîne de caractères |
auto_approve |
Approbation automatique | 1 | Non | int |
statut |
Statut (adopté/débloqué/clôturé/refusé) | adopter | Oui | chaîne de caractères |
Demander une démonstration
{
"site_ids": "40828",
"auto_approve": 1,
"status": "adopt"
}
Démonstration de la réponse
{
"code": 0,
"data": null,
"msg": "success"
}
API Éditeur
Authentification
Les requêtes API de l'éditeur doivent être adressées au point de terminaison suivant :
https://app.partnerboost.com/api.php?mod=medium&op={action}
Méthodes de requête HTTP
- POST application/x-www-form-urlencoded
- POST application/json
- OBTENIR
Format de retour
- JSON (par défaut)
- XML
Paramètre obligatoire
jeton- Le jeton API de votre chaîne (disponible dans votre tableau de bord d'éditeur)
Remarque
Chaque chaîne dispose de son propre jeton API unique. Vous pouvez retrouver vos jetons dans le Tableau de bord de l'éditeur, sous Outils > API.
Codes de résultat courants
| Code | Description |
|---|---|
0 |
Succès |
1000 |
L'éditeur n'existe pas |
1001 |
Jeton non valide |
1002 |
Fréquence d'appel trop élevée |
1003 |
Paramètres obligatoires manquants ou format incorrect |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"brand_type": "DTC",
"relationship": "Joined"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"brand_id": "66303",
"mcid": "joes",
"merchant_name": "Joe's Jeans",
"brand_type": "DTC",
"approval_type": "Auto",
"offer_type": "CPS",
"categories": "Apparel"
}
]
}
Transaction
POST
transaction
Récupérer la liste des transactions
Consultez le détail des transactions, l'état des commissions et bien plus encore.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=medium&op=transaction
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
date_début |
Début de la période de transaction. Il est obligatoire de renseigner soit la période de transaction, soit la période de validation. | 1er janvier 2024 |
date_fin |
Fin de la période de transaction | 31 janvier 2024 |
date_de_début_de_validation |
Début de la période de validation. La période de transaction ou la période de validation est obligatoire. | 1er janvier 2024 |
date_de_fin_de_validité |
Fin de la période de validation | 31 janvier 2024 |
Paramètres facultatifs
| Clé | Description | Exemple |
|---|---|---|
type |
Format de retour : json (par défaut) ou xml | json |
order_id |
Référence de commande | ORD123456 |
statut |
Statut de la commission : En attente, Approuvé, Refusé, Normal, Tous | Approuvé |
uid |
Votre variable de suivi personnalisée | suivi123 |
brand_id |
Identité de marque | 66303 |
mcid |
Identifiant unique de la marque | ulike0 |
page |
Index de la page actuelle | 1 |
limite |
Nombre de transactions par page (2 000 au maximum) | 100 |
Paramètres de retour
| Clé | Description |
|---|---|
channel_id |
Identifiant de chaîne |
total_page |
Nombre total de pages |
total_trans |
Nombre total de transactions de vente |
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
nom_du_commerçant |
Nom de marque |
order_id |
Référence de commande |
heure_de_commande |
Durée de la transaction |
montant_de_la_vente |
Montant de la vente |
sale_comm |
Commission sur les ventes |
statut |
État d'avancement de la commande |
uid |
Votre variable de suivi personnalisée |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"begin_date": "2024-01-01",
"end_date": "2024-01-31",
"status": "Approved"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": {
"channel_id": "500107",
"total_page": "1",
"total_trans": "1",
"list": [
{
"brand_id": "66303",
"mcid": "joes",
"merchant_name": "Joe's Jeans",
"order_id": "ORD123456",
"order_time": "1704067200",
"sale_amount": "100.00",
"sale_comm": "10.00",
"status": "Approved",
"uid": "tracking123"
}
]
}
}
Cliquez sur « Signaler »
PUBLIER
transfert
Obtenir le rapport sur les clics
Extrayer le journal détaillé des clics.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=medium&op=transfer
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
date_début |
Date et heure de début | 1er janvier 2024 00:00:00 |
date_fin |
Date et heure de fin | 1er janvier 2024, 01h00 |
Limite de débit
L'écart entre les valeurs des paramètres de date de début et de fin ne peut pas dépasser une heure. Maximum de 10 requêtes par minute.
Paramètres de retour
| Clé | Description |
|---|---|
channel_id |
Identifiant de chaîne |
total_page |
Nombre total de pages |
nombre_total_d'articles |
Total des transactions, ventilé par poste |
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
nom_du_commerçant |
Nom de marque |
uid |
Votre variable de suivi personnalisée |
click_time |
L'heure à laquelle le client clique sur votre lien (UTC+8) |
click_ref |
Un identifiant unique de référence de transaction |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"begin_date": "2024-01-01 00:00:00",
"end_date": "2024-01-01 01:00:00"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": {
"total_items": 1,
"list": [
{
"channel_id": "PB00039713",
"click_time": "2022-11-01 14:49:17",
"merchant_name": "24S Worldwide",
"brand_id": "66303",
"mcid": "24sevres",
"click_ref": "pb_xx95",
"uid": ""
}
]
}
}
Commission
POST
commission_commerçant
API de validation des commissions
Présente la répartition des commissions approuvées par marque, sur une base mensuelle.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=settlement&op=merchant_commission
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
date_début |
Date de début | 1er janvier 2024 |
date_fin |
Date de fin | 31 janvier 2024 |
Paramètres de retour
| Clé | Description |
|---|---|
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
sale_comm |
Commission sur les ventes |
date_de_règlement |
Date à laquelle la commission est approuvée et peut être retirée |
remarque |
Période au cours de laquelle le montant est généré |
identifiant_de_règlement |
L'identifiant unique indique que la commission a été approuvée par le commerçant |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"begin_date": "2024-01-01",
"end_date": "2024-01-31"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"brand_id": "66303",
"mcid": "joes",
"sale_comm": "37.73",
"settlement_date": "2018-04-27",
"note": "2016-01-01 ~ 2016-01-31, joes Sales Commission",
"settlement_id": "810b2ce13d1a3b640423"
},
{
"brand_id": "66304",
"mcid": "finishline",
"sale_comm": "17.45",
"settlement_date": "2018-04-27",
"note": "2016-01-01 ~ 2016-01-31, finishline Sales Commission",
"settlement_id": "c32ff2f5ec5553bb0423"
}
]
}
POST
commission_details
API « Détails de la commission »
Utilisez l'identifiant de règlement pour obtenir la répartition des commissions par transaction et par marque.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=settlement&op=commission_details
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
identifiant_de_règlement |
L'identifiant unique indique que la commission a été approuvée par le commerçant | 12345 |
Paramètres de retour
| Clé | Description |
|---|---|
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
nom_du_commerçant |
Nom de marque |
order_id |
Référence de commande |
heure_de_commande |
Durée de la transaction |
montant_de_la_vente |
Montant de la vente |
sale_comm |
Commission sur les ventes |
statut |
État d'avancement de la commande |
uid |
Votre variable de suivi personnalisée |
prod_id |
Référence du produit |
unité de commande |
Unité de commande Montant |
identifiant_de_règlement |
L'identifiant unique indique que la commission a été approuvée |
date_de_validation |
Date de validation de la transaction |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"settlement_id": "12345"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"brand_id": "66306",
"mcid": "katespade",
"merchant_name": "Kate Spade",
"order_id": "8720334",
"order_time": "1502949706",
"sale_amount": "69.00",
"sale_comm": "5.52",
"status": "Approved",
"uid": "120802|00yl70cf45100529c704",
"prod_id": "098687062527",
"order_unit": "1",
"settlement_id": "804a15b9ac6f5fa11113",
"validation_date": "2021-04-05",
"note": "order returned"
}
]
}
Paiement
POST
paiement_résumé
API de récapitulatif de paiement
Affiche l'historique de vos paiements.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=medium&op=payment_summary
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
payment_id |
Identifiant du paiement (les champs « payment_id » ou « paid_date_begin » et « paid_date_end » sont obligatoires) | 12345 |
date_de_début_du_paiement |
Date de début de la période de paie (AAAA-MM-JJ) | 1er janvier 2024 |
date_fin_paiement |
Date de fin de la période de paie (AAAA-MM-JJ) | 31 janvier 2024 |
Paramètres de retour
| Clé | Description |
|---|---|
payment_id |
L'identifiant de paiement figurant dans l'historique des paiements |
date_de_demande |
Date de création du paiement |
date_de_paiement |
Date à laquelle le paiement est considéré comme effectué |
mode_de_paiement |
Mode de paiement |
détails_de_paiement |
Informations sur le compte |
facture |
Informations relatives à la facture |
Montant |
Montant du paiement |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"paid_date_begin": "2024-01-01",
"paid_date_end": "2024-01-31"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": {
"total_items": "5",
"list": [
{
"payment_id": "3949",
"request_date": "2023-10-10",
"paid_date": "2023-10-10",
"invoice": "",
"amount": "$20.00",
"payment_details": "500107",
"payment_type": "Bank Wire"
},
{
"payment_id": "3952",
"request_date": "2023-10-10",
"paid_date": "2023-10-10",
"invoice": "",
"amount": "$30.00",
"payment_details": "500107",
"payment_type": "Bank Wire"
}
],
"page": 100,
"limit": 1
}
}
POST
détails_du_paiement
API des détails de paiement
Affiche le détail de votre paiement.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=medium&op=payment_detail
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
payment_id |
Identifiant du paiement (les champs « payment_id » ou « paid_date_begin » et « paid_date_end » sont obligatoires) | 12345 |
date_de_début_du_paiement |
Date de début de la période de paie (AAAA-MM-JJ) | 1er janvier 2024 |
date_fin_paiement |
Date de fin de la période de paie (AAAA-MM-JJ) | 31 janvier 2024 |
Paramètres de retour
| Clé | Description |
|---|---|
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
montant |
Montant de la commission ou montant de la prime |
date_de_validation |
Date d'approbation de la commission |
type |
Il peut s'agir d'une commission ou d'une prime |
remarque |
Période au cours de laquelle le montant est généré |
identifiant_de_règlement |
L'identifiant unique indique que la commission a été approuvée |
nom_du_commerçant |
Nom du commerçant |
payment_id |
L'identifiant de paiement figurant dans l'historique des paiements |
date_de_paiement |
Date à laquelle le paiement est considéré comme effectué |
sign_id |
Identifiant unique de l'enregistrement |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"payment_id": "3949"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"brand_id": "66306",
"mcid": "katespade",
"merchant_name": "Kate Spade",
"amount": "20.00",
"validation_date": "2023-10-10",
"type": "commission",
"note": "2023-09-01 ~ 2023-09-30",
"settlement_id": "804a15b9ac6f5fa11113",
"payment_id": "3949",
"paid_date": "2023-10-10",
"sign_id": "12345"
}
]
}
Monétisation
POST
monetization_api
API de monétisation
Vérifiez l'état des informations relatives à la marque et obtenez les liens de campagne pour monétiser votre trafic.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=medium&op=monetization_api
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Paramètres facultatifs
| Clé | Description | Exemple |
|---|---|---|
type |
Format de retour : json (par défaut) ou xml | json |
type_de_marque |
Types de marques : TikTok, vente directe aux consommateurs (DTC), Amazon, Walmart, distribution indirecte | DTC |
type_d'autorisation |
Filtrer par type d'approbation : Automatique, Manuel | Auto |
type_d'offre |
Filtrer par modèle tarifaire de la marque : CPS, CPA, CPC, CPL, CPX, CPM | CPS |
relation |
Filtrer par statut actuel de la relation avec la marque : Enregistré, En attente, Refusé, Aucune relation | Inscrit depuis |
catégories |
Filtrer par catégories de marques | Vêtements |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"brand_type": "DTC",
"relationship": "Joined"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"brand_id": "66303",
"mcid": "joes",
"merchant_name": "Joe's Jeans",
"brand_type": "DTC",
"approval_type": "Auto",
"offer_type": "CPS",
"categories": "Apparel"
}
]
}
Bon de réduction
POST
liste_des_coupons
API des bons de réduction
Profitez des bons de réduction et des offres promotionnelles proposées par les marques.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=coupon&op=coupon_list
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Jeton promotionnel | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Paramètres facultatifs
| Clé | Description | Exemple |
|---|---|---|
type_de_marque |
3 types de marques : D2C, Amazon, indirecte | D2C |
brand_id |
Identité de marque | 66303 |
mcid |
Identifiant unique de la marque | ulike0 |
piste |
Code de suivi dans le lien de suivi | piste 123 |
type |
Il existe deux types de bons : les bons de réduction et les offres spéciales | bon de réduction |
pays |
Les pays dans lesquels le bon peut être utilisé | US |
catégorie_d'origine |
Catégorie du commerçant proposant le bon de réduction | Vêtements |
niveau |
Niveaux 1 à 4, le niveau 1 étant le plus élevé | 1 |
lang |
Langue du bon de réduction | fr |
par page |
Nombre d'éléments par page (par défaut : 50, maximum : 2 000) | 100 |
page |
Index de la page actuelle (à partir de 1) | 1 |
created_at |
Date de création (AAAA-MM-JJ) | 1er janvier 2024 |
date_de_mise_à_jour |
Date de mise à jour (AAAA-MM-JJ) | 1er janvier 2024 |
Paramètres de retour
| Clé | Description |
|---|---|
creative_id |
Identifiant créatif |
brand_id |
Identité de marque |
restrictions |
Conditions d'utilisation des bons de réduction |
mots-clés |
Mots-clés |
image |
Image du bon de réduction |
vignette |
Vignette |
smart_url |
URL intelligente |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"brand_id": "66303",
"per_page": 100,
"page": 1
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"creative_id": "12345",
"brand_id": "66303",
"restrictions": "Minimum purchase $50",
"keywords": "fashion, apparel",
"image": "https://example.com/coupon.jpg",
"thumbnail": "https://example.com/thumb.jpg",
"smart_url": "https://partnerboost.com/smart/abc123"
}
]
}
Flux de données
PUBLIER
liste
API de la liste des flux de données
Obtenir les flux de données produits auprès des marques.
Point d'extrémité
https://app.partnerboost.com/api.php?mod=datafeed&op=list
Paramètres obligatoires
| Clé | Description | Exemple |
|---|---|---|
jeton |
Votre jeton API de chaîne | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Paramètres facultatifs
| Clé | Description | Exemple |
|---|---|---|
type |
Format de retour : json (par défaut) ou xml | json |
type_de_marque |
Types de marques : TikTok, DTC, Walmart | DTC |
brand_id |
Identité de marque | 66303 |
mcid |
Identifiant unique de la marque | ulike0 |
page |
Index de la page actuelle | 1 |
limite |
Nombre de produits par page (100 au maximum) | 50 |
mots-clés |
Mots-clés | chemise |
fourchette de prix |
L'une des valeurs suivantes : « 0-75 », « 75-150 », « 150-300 », « 300-500 », « 500-1000 », « 1000+ » | 75-150 |
remise_minimale |
L'un des 75, 50, 25, 10 | 25 |
Paramètres de retour
| Clé | Description |
|---|---|
nom |
Nom du produit |
description |
Description du produit |
brand_id |
Identité de marque |
mcid |
Identifiant unique de la marque |
nom_du_commerçant |
Le nom du commerçant qui vend ce produit |
url |
L'URL d'origine du produit |
image |
Le lien vers l'image du produit |
référence |
Référence du produit |
catégorie |
Catégorie de produits |
prix |
Prix actuel du produit |
tracking_url |
URL de suivi d'affiliation |
lien_de_suivi_court |
URL de suivi d'affiliation raccourcie |
tracking_url_smart |
URL de suivi d'affiliation intelligente |
date_de_mise_à_jour |
Date et heure de la dernière mise à jour |
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"brand_type": "DTC",
"limit": 50,
"page": 1
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "Success"
},
"data": [
{
"name": "Classic Cotton T-Shirt",
"description": "Comfortable cotton t-shirt",
"brand_id": "66303",
"mcid": "joes",
"merchant_name": "Joe's Jeans",
"url": "https://example.com/product/123",
"image": "https://example.com/images/product.jpg",
"sku": "SKU12345",
"category": "Apparel",
"price": "29.99",
"tracking_url": "https://partnerboost.com/track/abc123",
"tracking_url_short": "https://pb.co/abc",
"tracking_url_smart": "https://partnerboost.com/smart/abc123",
"updated_at": "2024-01-15 10:30:00"
}
]
}
Amazon
URL de base de l'API Amazon Publisher : https://amazon-service.partnerboost.com/amazon_api. Tous les points de terminaison ci-dessous utilisent PUBLICATION avec un corps JSON application/json.
POST
get_fba_products
API de récupération des produits
Filtrer et rechercher des produits Amazon selon différents critères (pagination, pays, marque, ASIN, promotions, etc.).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"page_size": 20,
"page": 1,
"default_filter": 0,
"country_code": "",
"brand_id": null,
"sort": "",
"asins": "",
"relationship": 1,
"is_original_currency": 0,
"has_promo_code": 0,
"has_acc": 0,
"filter_sexual_wellness": 0
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": {
"list": [
{
"product_id": "007d030d256e3e35774d65822f89c778",
"product_name": "Example Product",
"asin": "B0CQT26VCW",
"commission": "10%",
"category": "Appliances",
"url": "https://www.amazon.com/dp/B0CQT26VCW",
"brand_id": "90863",
"country_code": "US"
}
],
"has_more": true
}
}
POST
get_fba_products_link
API « Récupérer le lien vers les produits (ID de produit) »
Générer des liens de suivi à partir des identifiants de produits renvoyés par l'API « Get Products ».
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products_link
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"product_ids": "007d030d256e3e35774d65822f89c778",
"uid": "123"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": [
{
"product_id": "007d030d256e3e35774d65822f89c778",
"link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...",
"link_id": "5a19kG_aIdGFJrujZS3rjehf1RoROk2O8_bveeZQSggsULwwlmW2JT7vMOckEw0A_a1I_bNTErmMiVHobJT9S53Tvx7WFDtBnEGLhIcLwA8_c"
}
],
"error_list": [
{
"product_id": "111",
"message": "Product not found or no relationship"
}
]
}
POST
get_amazon_link_by_asin
API pour obtenir le lien vers les produits (ASIN)
Générer des liens de suivi des produits à partir des codes ASIN et de la place de marché.
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_by_asin
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"asins": "B0CQT26VCW",
"country_code": "US",
"uid": "",
"return_partnerboost_link": 0
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": [
{
"asin": "B0CQT26VCW",
"link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...",
"partnerboost_link": "",
"link_id": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c"
}
],
"error_list": [
{
"asin": "B0CQ2JMS731",
"country_code": "US",
"message": "Product not found or no relationship"
}
]
}
POST
get_amazon_joined_brands
API « Récupérer les marques partenaires »
Énumérez les marques Amazon avec lesquelles vous avez conclu un partenariat (avec pagination).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_joined_brands
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"bids": "90863",
"page_size": 20,
"page": 1
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": {
"list": [
{
"bid": "90863",
"brand_name": "Midea_US",
"support_storefront_link": "yes"
}
],
"hasMore": false
}
}
POST
get_fba_brand_link
API pour obtenir le lien vers la vitrine
Générer des liens de suivi pour les boutiques en ligne à partir des identifiants de marque (enchères).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_brand_link
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"bids": "90863",
"uid": "zxf"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": [
{
"bid": "90863",
"brand_name": "Midea_US",
"storefront_link": "https://www.amazon.com/stores/page/...",
"storefront_short_link": "https://pboost.me/JqLDkvht?uid=zxf",
"link_id": "2356UTnKtRt_atVWUJCB5mBgYP6bhTuU91YCLgLd4zZQclplXKUty8YgXL5jjRlmjAbAnmAIFPb8q8JDGvvng99S903nog6k_c"
}
],
"error_list": [
{
"bid": "77",
"brand_name": "test bid",
"message": "Bid not found or no relationship."
}
]
}
POST
get_amazon_link_status
API d'état des liens
Vérifiez si les liens promotionnels peuvent toujours être suivis à l'aide du link_id.
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_status
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"link_ids": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": [
{
"link_id": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c",
"active": true,
"asin": "B0CQT26VCW",
"brand_id": 90863,
"link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...",
"country": "US",
"type": "product",
"uid": ""
}
]
}
POST
get_amazon_report
API Amazon Report
Rapport sur la conversion des commandes / les performances des liens de suivi (période, place de marché, ASIN, groupes d'annonces, identifiants de commande).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_report
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"page_size": 100,
"page": 1,
"start_date": "20241201",
"end_date": "20241202",
"marketplace": "",
"asins": "",
"adGroupIds": "",
"order_ids": ""
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": {
"list": [
{
"asin": "B0C6DHK68Q",
"date": "20241202",
"marketplace": "US",
"currency": "USD",
"estCommission": 0,
"sales": 0,
"quantity": 0,
"conversionRate": "0.00%",
"clicks": 4,
"addToCarts": 0,
"detailPageViews": 2,
"productConversionType": "Promoted",
"link": "https://www.amazon.com/dp/...",
"uid": "sherry",
"adGroupId": "a6e3PBLq_ayRy2ZHjkvNvuSc3HqaLxHWh7tZO1jvSwkhTmyEsUJtgQga1fQOAqndyCMTs_aBKOVU6OLQmWZeLPfEGF9URtJkGJAQEXdWdQjhj5U2Jv7PmcjWf1Wgw6UYyiGHT3Wvz_c",
"order_id": "C1TIP-PJ09161555"
}
]
}
}
POST
get_latest_associates_products
API de la liste des ASIN associés
Filtrer et rechercher les codes ASIN du programme Partenaires Amazon (région, pagination).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_associates_products
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"page_size": 200,
"page": 1,
"filter_sexual_wellness": 0,
"region": "us"
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": {
"list": [
{
"brand_name": "cololight",
"asin": "B0DT9Q7CT2",
"commission": 0.15,
"region": "us",
"net_commission": 0.03,
"start_date": "2025-10-09T10:00:00-07:00",
"end_date": "2025-10-19T11:00:00-07:00",
"acc_commission_rate": 0.12,
"acc_start_date": "2025-08-01",
"acc_end_date": "2025-12-31",
"acc_budget": "10000.00",
"acc_spend": "518.80",
"acc_currency": "USD"
}
]
}
}
POST
get_latest_acc_products
API de liste d'ASIN d'Amazon Creator Connection
Filtrer et rechercher les ASIN des campagnes Amazon Creator Connection (ACC).
Point d'extrémité
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_acc_products
Demander une démonstration
{
"token": "79e33f8dac5a0be8579018760cff4cc227fb888d",
"page_size": 200,
"page": 1
}
Démonstration de la réponse
{
"status": {
"code": 0,
"msg": "success"
},
"data": {
"list": [
{
"bid": 73237,
"brand_name": "cololight",
"asin": "B0CXPD7ZN9",
"commission": "0.15",
"start_date": "2026-03-18T00:57:18-07:00",
"end_date": "2026-04-01T00:59:59-07:00",
"acc_campaign_id": "amzn1.campaign.3ABT368W9RO04",
"acc_commission_rate": "0.12",
"acc_start_date": "2026-03-10",
"acc_end_date": "2026-04-09",
"acc_budget": "5000.00",
"acc_spend": "0.00",
"acc_currency": "USD"
}
]
}
}
