Modules
Retourne la configuration du module newsletter GET
/v1/sites/{code_site}/prefs/newsletter.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"registration_success_msg": "string",
"unregistration_success_msg": "string",
"registration_error_msg": "string",
"unregistration_error_msg": "string"
}
Nom | Type | Description |
---|---|---|
registration_success_msg | string | Message de confirmation si l'inscription est validée |
unregistration_success_msg | string | Message de confirmation si la désinscription est validée |
registration_error_msg | string | Message de d'erreur si l'utilisateur est déjà inscrit |
unregistration_error_msg | string | Message de d'erreur si l'utilisateur n'est pas inscrit |
Modifie la configuration du module newsletter PUT
/v1/sites/{code_site}/prefs/newsletter.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
registration_success_msg | string | Message de confirmation si l'inscription est validée | |
unregistration_success_msg | string | Message de confirmation si la désinscription est validée | |
registration_error_msg | string | Message de d'erreur si l'utilisateur est déjà inscrit | |
unregistration_error_msg | string | Message de d'erreur si l'utilisateur n'est pas inscrit |
Liste les abonnés à la newsletter GET
/v1/sites/{code_site}/subscribers.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |||||
---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
is_registered | boolean | Filtre par inscription | |||||
limit | integer | Nombre d'éléments par page (valeur par défaut : 20, maximum : 500) | |||||
page | integer | Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut) | |||||
sort | array | Ordres de tri parmis les critères suivants :
|
Format de sortie :
data:[
{
"subscriber_id": "integer",
"email": "string",
"is_registered": "boolean",
"subscription_date": "string",
"subscription_date_f": "string",
"subscription_date_timestamp": "integer"
}
]
Nom | Type | Description |
---|---|---|
subscriber_id | integer | Identifiant de l'abonné |
email | string | Email de l'abonné |
is_registered | boolean | Etat de l'abonnement |
subscription_date | string | date de l'abonnement |
subscription_date_f | string | date formatée de l'abonnement |
subscription_date_timestamp | integer | timestamp de la date de l'abonnement |
Ajoute un abonné POST
/v1/sites/{code_site}/subscribers.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
email | Obligatoire | string | Mail de l'abonné |
is_registered | Obligatoire | boolean | Inscrit l'abonné (défaut : true) |
Format de sortie :
data:[]
Nom | Type | Description |
---|
Modifie un abonné PUT
/v1/sites/{code_site}/subscribers/{subscriber_id}.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
subscriber_id | Obligatoire | integer | Indetifiant l'abonné |
is_registered | Obligatoire | boolean | Inscrit l'abonné |
Format de sortie :
data:{
"subscriber_id": "integer",
"email": "string",
"is_registered": "boolean",
"subscription_date": "string",
"subscription_date_f": "string",
"subscription_date_timestamp": "integer"
}
Nom | Type | Description |
---|---|---|
subscriber_id | integer | Identifiant de l'abonné |
email | string | Email de l'abonné |
is_registered | boolean | Etat de l'abonnement |
subscription_date | string | date de l'abonnement |
subscription_date_f | string | date formatée de l'abonnement |
subscription_date_timestamp | integer | timestamp de la date de l'abonnement |
Supprime un abonné DELETE
/v1/sites/{code_site}/subscribers/{subscriber_id}.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
subscriber_id | Obligatoire | integer | Indetifiant de l'abonné |
Matomo
Google Analytics
Retourne la configuration de Google Analytics GET
/v1/sites/{code_site}/modules/analytics.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"UA": "string",
"is_enabled": "boolean",
"type": "string",
"target": "string",
"options": "string",
"consent": "string"
}
Nom | Type | Description |
---|---|---|
UA | string | Numéro de tracker sous la forme UA-xxxxxx-x |
is_enabled | boolean | Active ou non le tracker Analytics |
type | string | Type de tracker |
target | string | Position du tracker |
options | string | Paramètres supplémentaires du tracker |
consent | string | Demande de consentement |
Modifie la configuration de Google Analytics PUT
/v1/sites/{code_site}/modules/analytics.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |||||
---|---|---|---|---|---|---|---|
code_site | Obligatoire | string | Code site | ||||
UA | string | Numéro de tracker sous la forme UA-xxxxxx-x | |||||
is_enabled | boolean | Active ou non le tracker Analytics | |||||
type | string | Type de tracker Les valeurs attendues sont : sync, async, universal, gtag | |||||
target | string | Position du tracker, parmis les valeurs suivantes :
Les valeurs attendues sont : head, body | |||||
consent | string | Demande de consentement Les valeurs attendues sont : , tarteaucitron | |||||
options | string | Paramètres supplémentaires du tracker |
Points de fidelité
Retourne la configuration des points de fidélité GET
/v1/sites/{code_site}/prefs/fidelity.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"gain_rate": "integer",
"reward_first_order": "integer",
"reward_subscriber": "integer",
"is_creation_enabled": "boolean",
"creation_cost": "integer",
"voucher_mail_subject": "string",
"voucher_value": "float",
"voucher_validity": "integer",
"voucher_threshold": "float",
"is_voucher_restricted": "boolean"
}
Nom | Type | Description |
---|---|---|
gain_rate | integer | Gain par commande |
reward_first_order | integer | Bonus à la première commande |
reward_subscriber | integer | Bonus à l'inscription à la newsletter lors de l'ouverture de compte |
is_creation_enabled | boolean | Envoi du bon de réduction |
creation_cost | integer | Quantité de points pour un bon de réduction |
voucher_mail_subject | string | Sujet de l'email |
voucher_value | float | Montant du bon de réduction |
voucher_validity | integer | Durée de validité du bon de réduction en mois |
voucher_threshold | float | Seuil du bon de réduction |
is_voucher_restricted | boolean | Limiter l'utilisation du bon au membre qui le détient |
Modifie la configuration des points de fidélité PUT
/v1/sites/{code_site}/prefs/fidelity.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
gain_rate | integer | Gain par commande | |
reward_first_order | integer | Bonus à la première commande | |
reward_subscriber | integer | Bonus à l'inscription à la newsletter lors de l'ouverture de compte | |
is_creation_enabled | boolean | Envoi du bon de réduction | |
creation_cost | integer | Quantité de points pour un bon de réduction | |
voucher_mail_subject | string | Sujet de l'email | |
voucher_value | float | Montant du bon de réduction | |
voucher_validity | integer | Durée de validité du bon de réduction en mois | |
voucher_threshold | float | Seuil du bon de réduction | |
is_voucher_restricted | boolean | Limiter l'utilisation du bon au membre qui le détient |
Google Merchant Center
Retourne la configuration de Merchant Center GET
/v1/sites/{code_site}/prefs/merchantcenter.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"is_enabled": "boolean",
"distinct_url": "boolean",
"categories": "List",
"export_url": "string",
"last_export": "string"
}
Nom | Type | Description |
---|---|---|
is_enabled | boolean | Envoi du bon de réduction |
distinct_url | boolean | Url uniques pour les variantes |
categories | List | Catégories du flux d'export |
export_url Facultatif | string | URL du flux d'export |
last_export Facultatif | string | Date du dernier génération du flux d'export |
Modifie la configuration de Merchant Center PUT
/v1/sites/{code_site}/prefs/merchantcenter.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
is_enabled | boolean | Activation du flux | |
categories | array | Catégories du flux d'export | |
distinct_url | boolean | Url uniques pour les variantes |
Retourne la configuration de Merchant Center GET
/v1/sites/{code_site}/prefs/merchantcenter/categories.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
term | string | Recherche par libellé | |
limit | integer | Nombre d'éléments par page (valeur par défaut : 20, maximum : 20) | |
page | integer | Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut) |
Format de sortie :
data:[
{
"category_id": "integer",
"name": "string"
}
]
Nom | Type | Description |
---|---|---|
category_id | integer | Identifiant de la catégorie |
name | string | Intitulé de la catégorie |
Google reCaptcha
Retourne les préférences du captcha GET
/v1/sites/{code_site}/prefs/captcha.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"type": "string",
"recaptcha_key": "string",
"recaptcha_secret": "string"
}
Nom | Type | Description |
---|---|---|
type | string | Type de captcha |
recaptcha_key Facultatif | string | Clé reCaptcha du site |
recaptcha_secret Facultatif | string | Clé reCaptcha secrète |
Modifie les préférences du captcha PUT
/v1/sites/{code_site}/prefs/captcha.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
type | string | Type de captcha Les valeurs attendues sont : kiubi, recaptcha | |
recaptcha_key | string | Clé reCaptcha du site | |
recaptcha_secret | string | Clé reCaptcha secrète |
Avis vérifiés
Retourne la configuration de Avis-vérifiés GET
/v1/sites/{code_site}/prefs/avisverifies.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"id": "string",
"plateform": "string",
"secret": "string",
"offset": "integer",
"is_sending_products": "boolean",
"is_enabled": "boolean"
}
Nom | Type | Description |
---|---|---|
id | string | Identifiant |
plateform | string | Plateforme |
secret | string | Clé secrète |
offset | integer | Délai d'attente avant demande d'avis |
is_sending_products | boolean | Récolter les également les avis produits |
is_enabled | boolean | Active ou non Avis-vérifiés |
Modifie la configuration de Avis-vérifiés PUT
/v1/sites/{code_site}/prefs/avisverifies.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
id | string | Identifiant | |
plateform | string | Plateforme Les valeurs attendues sont : FR, ES, DE, IT, NL, UK, US, BR, PT, CO, PL, PE, CL, AU, NZ, MX | |
secret | string | Clé secrète | |
offset | integer | Délai d'attente avant demande d'avis | |
is_sending_products | boolean | Récolter les également les avis produits | |
is_enabled | boolean | Active ou non Avis-vérifiés |
IAdvize
Retourne la configuration de iAdvize GET
/v1/sites/{code_site}/prefs/iadvize.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"id": "string",
"is_enabled": "boolean"
}
Nom | Type | Description |
---|---|---|
id | string | Numéro de compte |
is_enabled | boolean | Active ou non iAdvize |
Modifie la configuration de iAdvize PUT
/v1/sites/{code_site}/prefs/iadvize.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
id | string | Numéro de compte | |
is_enabled | boolean | Active ou non iAdvize |
Lengow
Retourne la configuration de Lengow GET
/v1/sites/{code_site}/prefs/lengow.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"is_enabled": "boolean",
"categories": "List",
"id": "string",
"is_tracker_enabled": "boolean",
"export_url": "string",
"last_export": "string"
}
Nom | Type | Description |
---|---|---|
is_enabled | boolean | Active le flux d'export |
categories | List | Catégories du flux d'export |
id | string | Identifiant |
is_tracker_enabled | boolean | Active le tracker |
export_url Facultatif | string | URL du flux d'export |
last_export Facultatif | string | Date du dernier génération du flux d'export |
Modifie la configuration de Lengow PUT
/v1/sites/{code_site}/prefs/lengow.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
is_enabled | boolean | Active le flux d'export | |
categories | array | Catégories du flux d'export | |
id | string | Identifiant | |
is_tracker_enabled | boolean | Active le tracker |
Retourne la configuration de Facebook GET
/v1/sites/{code_site}/prefs/facebook.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"is_enabled": "boolean",
"categories": "List",
"mapping": "List",
"description": "string",
"export_url": "string",
"last_export": "string"
}
Nom | Type | Description |
---|---|---|
is_enabled | boolean | Active le flux d'export |
categories | List | Catégories du flux d'export |
mapping | List | Mapping des catégorie pour facebook |
description | string | Champ utilisé pour la description |
export_url Facultatif | string | URL du flux d'export |
last_export Facultatif | string | Date du dernier génération du flux d'export |
Modifie la configuration de Facebook PUT
/v1/sites/{code_site}/prefs/facebook.json
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
is_enabled | boolean | Active le flux d'export | |
categories | array | Catégories du flux d'export | |
mapping | array | Mapping des catégorie pour facebook | |
description | string | Champ utilisé pour la description Les valeurs attendues sont : description, header, excerpt, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15 |
Retourne les préférences ADS GET
/v1/sites/{code_site}/prefs/ads.json
Authorized Digital Sellers vous permet de vendre votre inventaire publicitaire numérique uniquement par l'intermédiaire de vendeurs (comme Google Ads, par exemple) que vous avez identifiés comme étant autorisés.
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
Format de sortie :
data:{
"ads": "string",
"app_ads": "string"
}
Nom | Type | Description |
---|---|---|
ads | string | Vendeurs autorisés |
app_ads | string | Vendeurs autorisés pour les applications |
Modifie les préférences ADS PUT
/v1/sites/{code_site}/prefs/ads.json
Modifie les préférences Authorized Digital Sellers pour le site et les applications.
Paramètres supportés par ce endpoint :
Nom | Type | Description | |
---|---|---|---|
code_site | Obligatoire | string | Code site |
ads | string | Vendeurs autorisés | |
app_ads | string | Vendeurs autorisés pour les applications |