automations/trigger/{techName} (POST)
Ce endpoint permet de déclencher une automation qui possède le déclencheur Appel API Manuel.
L'automation déclenchée dépendra du paramètre techName qui sera transmis via l'appel.
Endpoint : https://social-sb.com/api/v3/automations/trigger/{techName}
Verbe HTTP : POST
Paramètres obligatoires :
techName: Identifiant technique du déclencheur de l'automation
publicKey: Clé publique API de votre compte SPREAD
privateKey: Clé privée API de votre compte SPREAD
Exemple de code
Paramètres obligatoires pour $data :
keydoit contenir un tableau clé / valeur avec :- en clé, le nom de l'identifiant
- en valeur, l'identifiant
customerEmail: L'email du profil
Paramètres complémentaires pour $data :
Vous pouvez ajouter toutes les données que vous souhaitez.
Elles seront ensuite disponibles dans l'éditeur d'email de votre automation.
$techName = 'techName'; // À modifier
$publicKey = 'xxxxx'; // À modifier
$data = [
"key" => ["cartId" => 12345], // obligatoire
"customerEmail" => "toto@gmail.com", // obligatoire
"cart_items_count" => "4",
"cart_items_qty" => "4",
"cart_currency_code" => "EUR",
"cart_grandTotal" => "106.82",
"items" => [
[
"idProduct" => "6",
"unique_id" => "00000000060000000000100",
"name" => "Mug The best is yet to come",
"description_short" => "Mug en céramique blanche, 325ml.",
"category" => "accessoires-de-maison",
"manufacturer_name" => "Studio Design",
"price" => "11.9",
"total_price" => "14.28",
"quantity" => "1",
"lienProduit" => "https://xxx",
"lienImage" => "https://xxxx",
"legend" => "Mug The best is yet to come"
]
]
];
$ch = curl_init('https://social-sb.com/api/v3/automations/trigger/'.$techName);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $publicKey . ":" . $privateKey);
$result = curl_exec($ch);automations/stop/{techName} (POST)
Ce endpoint permet d'arrêter toutes les exécutions d'automations possédant le déclencheur Appel API Manuel (en fonction du techName passé et de la clé transmise).
Endpoint : https://social-sb.com/api/v3/automations/stop/{techName}
Verbe : POST
Paramètres obligatoires :
techName: Identifiant technique du déclencheur de l'automation
publicKey: Clé publique API de votre compte SPREAD
privateKey: Clé privée API de votre compte SPREAD
Exemple de code
Paramètres obligatoires pour $data :
keydoit contenir un tableau clé / valeur avec :- en clé, le nom de l'identifiant
- en valeur, l'identifiant
Le tableau $data peut contenir d'autres données : elles seront ignorées.
$techName = 'abandoned_cart'; // À modifier
$publicKey = 'xxxxx'; // À modifier
$privateKey = 'xxxxx'; // À modifier
$data = [
"key" => ["cart_id" => 12345], // obligatoire. Permet de cibler quelles automations arrêter
];
$ch = curl_init('https://social-sb.com/api/v3/automations/stop/'.$techName);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $publicKey . ":" . $privateKey);
$result = curl_exec($ch);Cas spécifique de l’Abandon de panier
automations/trigger/abandoned_cart
Ce endpoint permet de déclencher une automation qui possède le déclencheur Mise à jour de panier.
Il doit être appelé à chaque modification du panier.
Endpoint : https://social-sb.com/api/v3/automations/trigger/abandoned_cart
Verbe HTTP : POST
Paramètres obligatoires :
publicKey: Clé publique API de votre compte SPREAD
privateKey: Clé privée API de votre compte SPREAD
Paramètres obligatoires pour $data :
key: doit contenir un tableau clé / valeur avec en clécartIdet en valeur l'id du panier.
customerEmail: L'email du client
Paramètres complémentaires pour $data :
Vous pouvez ajouter toutes les données que vous souhaitez. Elles seront ensuite disponible dans l'éditeur d'email de votre automation.
$publicKey = 'xxxxx'; // À modifier
$privateKey = 'xxxxx'; // À modifier
$data = [
"key" => ["cart_id" => 90], // Id du cart dans Presta
"customerEmail" => "toto@mail.tld", // Email du customer dans Presta
"data" => [
"store_id" => 1, // Id du store (Util quand Multiboutique)
"cart_creationDate" => "2020-03-10 15:51:15", // Date de creation du cart
"cart_updateDate" => "2020-03-10 16:18:04", // date derniere MAJ du cart
"is_active" => 1, // Cart Active ou non ?
"cart_products_count" => 1, // Nombre d'items dans le cart
"cart_currency_code" => "EUR", // La monnaie utilisé dans le cart
"customer_group_id" => 1, // Id du group du customer dans Presta
"coupon_code" => "TEST-CodePromo", // Si code Promo utilisé sinon vide
"coupon_code_name" => "Test 5e621a7ce46f", // Label du code promo dans presta
"is_persistent" => 1, // Persistant ou non
"cart_url" => "http://www.exemple.tld/panier", // Url vers le panier
"cart_fdp" => 2, // Frais de port
"cart_fdm" => 2, // Frais de manutention
"cart_subTotal" => 32.74, // Prix sans Frais de port
"cart_subTotalWithDiscount" => 32.74,
"cart_grandTotal" => 32.74, // Le prix TOTAL à Payer avec Frais de port
"products" => [
"0" => [ // Un array par item
"idProduct" => 2, // ID du produit
"id_shop" => 1, // id du shop du produit (si multiboutique)
"name" => "Mon Produit", // Nom du produit
"description_short" => "Ma description Courte.", // Desc Courte du produit
"attributes" => [
"Taille : S",
"Couleur : Bleu"
], //Attributs du produit
"available_now" => true, // Est il disponible maintenant
"available_later" => true, // disponibilité plus tard
"available_date" => "0000-00-00", // Date de disponibilité
"category" => [
"femmes",
"Soldes été"
],
"manufacturer_name" => "Studio Design",
"price_without_reduction" => 43.08,
"price_with_reduction" => 34.464,
"price_without_reduction_without_tax" => 35.9,
"price_with_reduction_without_tax" => 28.72,
"additional_shipping_cost" => 0.00,
"quantity" => 1,
"lienProduit" => "http://ps17.spreadfamily.fr/2-sweater.html",
"lienImage" => "ps17.spreadfamily.fr/21-home_default/brown-sweater.jpg",
"legend" => "Pull imprimé ours brun",
],
"1" => [
// ...
],
"2" => [
// ...
]
]
]
];
$ch = curl_init('https://social-sb.com/api/v3/automations/trigger/abandoned_cart');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $publicKey . ":" . $privateKey);
$result = curl_exec($ch);automations/stop/abandoned_cart
Ce endpoint permet d'arrêter toutes les exécutions d'automations possédant le déclencheur Mise à jour du panier.
Il doit être appelé lorsque le panier est vidé.
Endpoint : https://social-sb.com/api/v3/automations/stop/abandoned_cart
Verbe : POST
Paramètres obligatoires :
publicKey: Clé publique API de votre compte SPREAD
privateKey: Clé privée API de votre compte SPREAD
Exemple du panier abandonné
Paramètres obligatoires pour $data :
key: doit contenir un tableau clé / valeur avec en clécartIdet en valeur l'id du panier.
Le tableau $data peut contenir d'autres données : elles seront ignorées.
$publicKey = 'xxxxx'; // À modifier
$data = [
"key" => ["cartId" => 12345], // obligatoire. Permet de cibler quelles automations arrêter
];
$ch = curl_init('https://social-sb.com/api/v3/automations/stop/abandoned_cart');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $publicKey . ":" . $privateKey);
$result = curl_exec($ch);