Cette API permet aux utilisateurs de récupérer les offres en espèces, les transactions et les informations de portefeuille, ainsi que de gérer efficacement les coupons, les parrainages et les informations de niveau.
Authentification
Pour accéder à l'API, vous devez inclure une clé API dans les en-têtes de vos requêtes.
En-tête :
Autorisation : Porteur : VOTRE_CLÉ_API
Accepter : application/json
wpcb : oui
Comment générer la clé API du portefeuille Webplanex ?
1. Connectez-vous à votre espace d'administration WebplanexWallet.
2. Accédez à Intégrations > API du portefeuille Webplanex.
3. Cliquez sur « Obtenir un jeton » Bouton permettant de générer un jeton pour la boutique.
URL de base
Tous les points de terminaison de l'API sont accessibles via l'URL de base suivante :
https://cashback.webplanex.com/
Points de terminaison
1. Obtenir des offres
Point de terminaison : /api/offers?shop={{URL de la boutique Shopify}}&customer={{ID client Shopify}}
Méthode : GET
Description : Récupérer la liste de toutes les offres en espèces disponibles en magasin.
Réponse :
200 OK
{
« Devise » : « Rs. »,
« État » : 200,
« Message » : « Réussite »,
« Données » : {
« 0 » : {
« Identifiant » : 1,
"nom": "Achat total",
"appliquer_sur": ",
"quantité": 0,
"description": "Obtenez 20 % de remise en magasin sur un achat total minimum de 1 roupie.",
"type": 4,
"créé à": "2023-12-07T12:03:27.000000Z",
"mis à jour à": "2024-06-20T06:07:49.000000Z",
"show_link_attr": "style=\"text-decoration: none;\"",
"show_description": "Obtenez 20 % de remise en magasin sur un achat total minimum de 1 roupie.",
"getOfferTypeName": "Achat total"
},
"1": {
"id": 2,
"nom": "Test d'offre de collecte",
"appliquer_sur": "collecte",
"quantité": 0,
"description": "<a href=\"/collections/hydrogen\">Test d'offre de collecte Hydrogen</a>",
"type": 0,
"created_at": "2023-12-26T10:19:12.000000Z",
"updated_at": "2024-07-11T04:06:59.000000Z",
"show_link_attr": "",
"show_description": "<a href=\"/collections/hydrogen\">Test de l'offre de collection Hydrogen</a>",
"getOfferTypeName": "Stocker de l'argent sur les produits OU les collections"
},
"chemin": "https://cashback.webplanex.com/api/offers",
"par_page": 10,
"curseur_suivant": null,
"url_page_suivante": null,
"curseur_précédent": null,
"url_page_précédente": null
}
}
2. Obtenir des coupons
Point de terminaison : /api/coupons?shop={{URL de la boutique Shopify}}
Méthode : GET
Description : Récupérer la liste de tous les couponsCoupons disponibles.
Réponse :
200 OK
{
"statut" : 200,
"message" : "Réussite",
"données" : {
"123" : {
"code": "xcodecodetset",
"value_type": "percentage",
"value": 1,
"coupon_starts_at": "07 août 2024",
"coupon_ends_at": "14 août 2024",
"append_type": "%",
"final_value": "1%",
"details": [
« 1 % de réduction sur les accessoires de la collection »,
« Tous les clients »,
« Actif à partir du 7 août 2024 »
]
},
"456 » : {
"code": "zcodecodetst",
"type_valeur": "pourcentage",
"valeur": 1,
"début_du_coupon": "07 août 2024",
"coupon_ends_at": "14 août 2024",
"append_type": "%",
"final_value": "1%",
"details": [
« 1 % de réduction sur les accessoires de la collection »,
« Tous les clients »,
« Actif à partir du 7 août 2024 »
]
}
}
}
3. Générer un lien de parrainage
Point de terminaison : /api/referrals?shop={{URL de la boutique Shopify}}
Méthode : POST
Description : Générer un lien de parrainage
Corps de la requête :
{
« customer_id » : « {{shopify customer id}} »
}
Réponse :
200 OK
{
"status » : 200,
"message » : « Success »
}
4. Obtenir un lien de parrainage
Point de terminaison : /api/referrals/{{shopify customer id}}?shop={{shopify store url}}
Méthode : GET
Description : Récupérer un lien de parrainage
Réponse :
200 OK
{
"status": 200,
« message » : « Réussite »,
« données » : {
« url_de_parrainage » : « https://xyz.com/d296ef »
}
}
5. Obtenir le portefeuille client
Point de terminaison : /api/customerwallet/{{shopify customer id}}?shop={{shopify store url}}
Méthode : GET
Description : Récupérer les informations de mon portefeuille
Réponse :
200 OK
{
"status": 200,
« message » : « Réussite »,
« données » : {
« devise » : « Rs. »,
« solde » : [
{
&