Avaliações – API REST

Avaliações integra-se com a API REST do EDD permitindo que você recupere avaliações em formato JSON ou XML.

A API REST do EDD fornece um endpoint chamado /reviews/. O endpoint de avaliações permite consultar o banco de dados e recuperar uma lista de avaliações colocadas em todos os produtos da sua loja. Uma consulta básica de avaliações se parece com isto:

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

Para cada avaliação retornada, você receberá as seguintes informações:

• id – O ID exclusivo da avaliação
• title – O título da avaliação
• parent – Se a avaliação for uma resposta, este é o ID da avaliação pai
• download_id – O ID do download para o qual esta avaliação foi criada
• download_title – Título do download para o qual esta avaliação foi criada
• rating – A classificação dada pelo avaliador. Será null para uma resposta.
• author – O nome do autor da avaliação
• email – O endereço de e-mail do autor da avaliação
• IP – O endereço IP de onde a avaliação foi enviada
• date – A data em que a avaliação foi enviada
• date_gmt – A data (em GMT) em que a avaliação foi enviada
• content – O conteúdo da avaliação
• status – O status da avaliação. 1 representa aprovado e 0 representa não aprovado (pendente). O status também pode ser “spam” ou “trash”
• user_id – O ID do usuário do WordPress do autor da avaliação
• type – Se é uma avaliação ou resposta, dependendo do que for
• votes – O número de pessoas que votaram que esta avaliação é útil ou inútil. Será null para uma resposta. Se for uma avaliação, terá sub-chaves de yes e no

Uma resposta de consulta de avaliações se parece com isto:

{
    "reviews": {
        "total": "2",
        "most_recent": [
            {
                "id": "63",
                "title": null,
                "parent": "60",
                "download_id": "1568",
                "download_title": "Endless Possibilities",
                "rating": null,
                "author": "Sunny Ratilal",
                "email": "[email protected]",
                "IP": "172.17.0.1",
                "date": "2016-07-20 17:24:48",
                "date_gmt": "2016-07-20 17:24:48",
                "content": "Replying to test review",
                "status": "1",
                "user_id": "1",
                "type": "reply",
                "votes": null
            },
            {
                "id": "61",
                "title": "Great read",
                "parent": "0",
                "download_id": "1566",
                "download_title": "eBook",
                "rating": "4",
                "author": "Sunny Ratilal",
                "email": "[email protected]",
                "IP": "172.17.0.1",
                "date": "2016-07-19 19:25:22",
                "date_gmt": "2016-07-19 19:25:22",
                "content": "Well written book",
                "status": "1",
                "user_id": "1",
                "type": "review",
                "votes": {
                    "yes": "3",
                    "no": "0"
                }
            },
        ]
    },
    "request_speed": 0.08372688293457
}

Certos parâmetros de consulta podem ser anexados à consulta base. Se você quiser receber os dados de uma única avaliação, pode adicionar o parâmetro &review_id={identifier}, assim:

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&review_id=61

A resposta para uma única avaliação se parece com isto:

{
    "reviews": {
        "id": "61",
        "title": "Great read",
        "parent": "0",
        "download_id": "1566",
        "download_title": "eBook",
        "rating": "4",
        "author": "Sunny Ratilal",
        "email": "[email protected]",
        "IP": "172.17.0.1",
        "date": "2016-07-19 19:25:22",
        "date_gmt": "2016-07-19 19:25:22",
        "content": "Well written book",
        "status": "1",
        "user_id": "1"
    },
    "request_speed": 0.0022079944610596
}

Se você quiser ver todas as avaliações de um único download, pode adicionar o parâmetro &download_id={identifier}, assim:

https://yoursite.com/edd-api/reviews/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&download_id=1568

A consulta acima gerará uma resposta semelhante à acima, mas terá várias sub-chaves sob a chave reviews