Configuration de la Boutique

Dans cette section, vous apprendrez comment configurer votre boutique pour enregistrer les actions d'achat et les évaluations de produits.

Utilisation de la Clé d'API

Pour enregistrer les actions de votre boutique, vous avez besoin de la clé d'API de la boutique. Vous la trouverez sur la page Mes boutiques en cliquant sur le bouton Clé d'API pour la boutique correspondante.

Une fois que vous avez votre clé d'API, vous pouvez commencer à envoyer des actions à notre serveur.

Exemple de clé d'API :

cleard.sapun.bg.n81sjpKAg1Or

Pour créer un enregistrement avec succès, incluez votre clé d'API dans un en-tête dédié dans la requête POST : cleard-api-key.

Envoyez la requête POST à https://cleard.com/api/action.

Paramètres de la Requête

Vos requêtes doivent inclure les paramètres suivants :

Pour ajouter au panier :

{
    "link": "https://sapun.bg/vanilla-soap", // Lien vers la page de votre produit
    "title": "Vanilla soap", // Titre de votre produit
    "image": "https://sapun.bg/images/vanilla-soap.png", // Image du produit
    "type": "add-to-cart", // Type d'enregistrement. Peut être "add-to-cart" ou "rate"
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identifiant de l'utilisateur qui a effectué l'action ➀
    }
}

Pour ajouter une évaluation à un produit :

{
    "link": "https://sapun.bg/vanilla-soap", // Lien vers la page de votre produit
    "title": "Vanilla soap", // Titre de votre produit
    "image": "https://sapun.bg/images/vanilla-soap.png", // Image du produit
    "type": "rate", // Type d'enregistrement. Peut être "add-to-cart" ou "rate"
    "rating": {
        "rate": 4, // Évaluation du produit. La valeur doit être comprise entre 1 et 5 inclus.
        "description": "Great soap!" // Commentaire d'évaluation. Optionnel.
    },
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identifiant de l'utilisateur qui a effectué l'action ➀
    }
}

➀ Identifiant de l'Utilisateur

L'identifiant de l'utilisateur peut être obtenu à partir du cookie cleard-user.

Si l'utilisateur n'est pas connecté à son compte Clear'd, il n'y aura pas d'identifiant. Dans ce cas, vous pouvez envoyer le nom et la photo de l'utilisateur de votre propre base de données comme suit :

{
    ...
    "user": {
        "name": "John Doe", // Nom de l'utilisateur
        "photoURL": "https://sapun.bg/images/avatars/user-22.png" // Photo de l'utilisateur
    }
}