Configuração da Loja

Nesta seção, você aprenderá como configurar sua loja para registrar ações de compra e avaliações de produtos.

Uso da Chave de API

Para registrar ações da sua loja, você precisa da chave de API da loja. Você pode encontrá-la na página Minhas lojas, clicando no botão Chave de API da loja correspondente.

Depois de obter sua chave de API, você já pode enviar ações para o nosso servidor.

Exemplo de chave de API:

cleard.sapun.bg.n81sjpKAg1Or

Para registrar uma ação com sucesso, inclua sua chave de API em um cabeçalho específico da requisição POST: cleard-api-key.

Envie a requisição POST para https://cleard.com/api/action.

Parâmetros da Requisição

Suas requisições devem incluir os seguintes parâmetros:

Para adicionar ao carrinho:

{
    "link": "https://sapun.bg/vanilla-soap", // Link para a página do seu produto
    "title": "Vanilla soap", // Título do seu produto
    "image": "https://sapun.bg/images/vanilla-soap.png", // Imagem do produto
    "type": "add-to-cart", // Tipo do registro. Pode ser "add-to-cart" ou "rate"
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identificador do usuário que realizou a ação ➀
    }
}

Para adicionar uma avaliação a um produto:

{
    "link": "https://sapun.bg/vanilla-soap", // Link para a página do seu produto
    "title": "Vanilla soap", // Título do seu produto
    "image": "https://sapun.bg/images/vanilla-soap.png", // Imagem do produto
    "type": "rate", // Tipo do registro. Pode ser "add-to-cart" ou "rate"
    "rating": {
        "rate": 4, // Avaliação do produto. O valor deve ser de 1 a 5, inclusive.
        "description": "Great soap!" // Comentário da avaliação. Opcional.
    },
    "user": {
        "id": "XGwitmzWH8PmrH7lU5NrrZnM1Ow2" // Identificador do usuário que realizou a ação ➀
    }
}

➀ Identificador do Usuário

O identificador do usuário pode ser obtido a partir do cookie cleard-user.

Se o usuário não estiver conectado à conta Clear'd, não haverá identificador. Nesse caso, você pode enviar o nome e a foto do usuário da sua própria base de dados da seguinte forma:

{
    ...
    "user": {
        "name": "John Doe", // Nome do usuário
        "photoURL": "https://sapun.bg/images/avatars/user-22.png" // Foto do usuário
    }
}