Leia mais sobre utilização de APIs assíncronas: https://yourviews.freshdesk.com/support/solutions/articles/5000784346-introducão


Integração de reviews de produtos

Permite salvar um novo review de um determinado produto. 

Espera-se, além do review, que seja informado qual o produto que está sendo avaliado e qual o cliente que está fazendo a avaliação.


Lembre-se de ler sobre a introdução e autenticação da API: https://yourviews.freshdesk.com/support/solutions/articles/5000734890-api-basic-auth-primeiros-passos-e-autenticac%C3%A3o


IMPORTANTE: Você também pode verificar essa documentação com exemplos em nossa coleção do Postman:

https://documenter.getpostman.com/view/3359543/yourviews-api/RVu8gSWM#77aa0ff0-5e59-f6b6-70cd-6b889342a368


Inserir um review de produto

Endpoint: POST /asyncreview/


Para inserir um review, você deve informar todos os campos do mesmo.  A tabela abaixo compila todos os campos (obrigatórios e opcionais) que podem ser enviados.


Review    
Estrutura principal do review
Obrigatório?    
Tipo
Rating
Nota dada pelo cliente. Entre 1 e 5.
Sim
int
Date    
Data em que o review foi escrito. Formato: yyyy-MM-ddTHH:mm:ss
Sim
DateTime
Review
Texto do review.
Sim
string
User
Nó do usuário que escreveu a avaliação


Name
Nome completo do cliente
Sim
string
E-mail
E-mail do cliente
Sim    
string
IPAddress
Endereço de IP do cliente que escrever review. Utilizado para detecção de anomalias
Não
string
Product
Nó com dados sobre o produto avaliado


Name
Nome do produto, como aparece na loja
Sim
string
Image
Foto do produto, como na loja
Sim
string
Url
URL completa do produto
Sim
string
ProductId
Id do produto, como aparece na loja
Sim
string
CustomerPhotos
Lista de fotos (links) do cliente com o produto comprado
Não
Lista de string


Exemplo de chamada

Para exemplificar a tabela acima, o JSON abaixo dá uma ideia de como os dados devem ser enviados.


HTML

{
    "Rating": 5,
    "Review": "otimo 21.03.2018",
    "Date": "2016-09-20T05:18:34",
    "Likes": 2,
    "Dislikes": 2,
    "CustomFields": [
        {
            "Name": "Caimento",
            "Values": [
                "Excelente"
            ]
        },
        {
            "Name": "Qualidade do tecido",
            "Values": [
                "Excelente"
            ]
        },
        {
            "Name": "Tamanho",
            "Values": [
                "G"
            ]
        },
        {
            "Name": "Sexo",
            "Values": [
                "Masculino"
            ]
        },
        {
            "Name": "Uso do produto",
            "Values": [
                "trabalho"
            ]
        },
        {
            "Name": "Você recomenda esse produto a um amigo?",
            "Values": [
                "Não"
            ]
        }
    ],
    "User": {
        "YourviewsUserId": 0,
        "Name": "User teste",
        "Email": "userteste@yourviews.com.br",
        "City": null,
        "State": null,
        "ZipCode": null,
        "IPAddress": null
    },
    "Product": {
        "YourviewsProductId": 0,
        "ProductId": "8293681",
        "Name": "Camiseta Descolada",
        "Url": "http://demo.yourviews.com.br/camiseta-descolada",
        "Image": "https://cdn.awsli.com.br/600x450/268/268174/produto/8293681/e7397e2505.jpg",
        "IsActive": false,
        "Value": 0,
        "Category": null,
        "Brand": null,
        "Sku": null
    },
    "ReferenceOrder": null,
    "CustomerPhotos": null
}