Настройка на магазин

В тази секция ще научите как да настроите магазина си да записва действия при покупка или добавяне на рейтинг към продукти.

Използване на API ключа

За да записвате действия от магазина си, ще ви е необходим API ключът на магазина. Ще го намерите на страницата Моите магазини, като натиснете бутона API ключ за съответния магазин.

След като вече имате своя API ключ, можете да записвате действия към нашия сървър.

Примерен API ключ:

cleard.sapun.bg.n81sjpKAg1Or

За да направите успешен запис, трябва да включите своя API ключ в специален хедър към POST заявката: cleard-api-key.

POST заявката се изпраща към https://cleard.com/api/action.

Параметри на заявката

Вашите заявки трябва да имат следните параметри:

За добавяне в количката:

{
    "link": "https://sapun.bg/vanilla-soap", // Връзка към страницата на вашия продукт
    "title": "Ванилов сапун", // Заглавието на вашия продукт
    "image": "https://sapun.bg/images/vanilla-soap.png", // Изображение на продукта
    "type": "add-to-cart", // Типът на записа. Може да е "add-to-cart" или "rate"
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Идентификаторът на потребителя, който е извършил действието ➀
    }
}

За добавяне на рейтинг към продукт:

{
    "link": "https://sapun.bg/vanilla-soap", // Връзка към страницата на вашия продукт
    "title": "Ванилов сапун", // Заглавието на вашия продукт
    "image": "https://sapun.bg/images/vanilla-soap.png", // Изображение на продукта
    "type": "rate", // Типът на записа. Може да е "add-to-cart" или "rate"
    "rating": {
        "rate": 4, // Рейтингът на продукта. Стойността трябва да е от 1 до 5 включително.
        "description": "Страхотен сапун" // Коментар към рейтинга. Незадължителен.
    },
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Идентификаторът на потребителя, който е извършил действието ➀
    }
}

➀ Идентификатор на потребителя

Идентификаторът на потребителя може да бъде взет от бисквитката (cookie) cleard-user.

Ако потребителят не е влязъл в своя Clear'd акаунт, няма да има идентификатор. В този случай можете да добавите името и снимката на потребителя от вашата база данни по следния начин:

{
    ...
    "user": {
        "name": "Иван Иванов", // Името на потребителя
        "photoURL": "https://sapun.bg/images/avatars/user-22.png" // Снимката на потребителя
    }
}