Shop-Konfiguration

In diesem Abschnitt erfahren Sie, wie Sie Ihren Shop so konfigurieren, dass er Kauf- und Produktbewertungsaktionen aufzeichnet.

Verwendung des API-Schlüssels

Um Aktionen von Ihrem Shop aufzuzeichnen, benötigen Sie den API-Schlüssel des Shops. Sie finden ihn auf der Seite Meine Shops, indem Sie auf die Schaltfläche API-Schlüssel für den entsprechenden Shop klicken.

Sobald Sie Ihren API-Schlüssel haben, können Sie damit beginnen, Aktionen an unseren Server zu senden.

Beispiel-API-Schlüssel:

cleard.sapun.bg.n81sjpKAg1Or

Um einen Datensatz erfolgreich zu erstellen, fügen Sie Ihren API-Schlüssel in einen eigenen Header in der POST-Anfrage ein: cleard-api-key.

Senden Sie die POST-Anfrage an https://cleard.com/api/action.

Anforderungsparameter

Ihre Anfragen müssen die folgenden Parameter enthalten:

Zum Hinzufügen zum Warenkorb:

{
    "link": "https://sapun.bg/vanilla-soap", // Link zur Seite Ihres Produkts
    "title": "Vanilla soap", // Titel Ihres Produkts
    "image": "https://sapun.bg/images/vanilla-soap.png", // Produktbild
    "type": "add-to-cart", // Datensatztyp. Kann "add-to-cart" oder "rate" sein
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Kennung des Benutzers, der die Aktion ausgeführt hat ➀
    }
}

Zum Hinzufügen einer Bewertung zu einem Produkt:

{
    "link": "https://sapun.bg/vanilla-soap", // Link zur Seite Ihres Produkts
    "title": "Vanilla soap", // Titel Ihres Produkts
    "image": "https://sapun.bg/images/vanilla-soap.png", // Produktbild
    "type": "rate", // Datensatztyp. Kann "add-to-cart" oder "rate" sein
    "rating": {
        "rate": 4, // Produktbewertung. Der Wert muss zwischen 1 und 5 liegen (inklusiv).
        "description": "Great soap!" // Bewertungskommentar. Optional.
    },
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Kennung des Benutzers, der die Aktion ausgeführt hat ➀
    }
}

➀ Kennung des Benutzers

Die Benutzerkennung kann aus dem cleard-user Cookie abgerufen werden.

Wenn der Benutzer nicht in seinem Clear'd-Konto angemeldet ist, gibt es keine Kennung. In diesem Fall können Sie den Namen und das Foto des Benutzers aus Ihrer eigenen Datenbank wie folgt senden:

{
    ...
    "user": {
        "name": "John Doe", // Name des Benutzers
        "photoURL": "https://sapun.bg/images/avatars/user-22.png" // Foto des Benutzers
    }
}