Reviews – REST API

Reviews integreert met de EDD REST API, waardoor je beoordelingen kunt ophalen in JSON- of XML-formaat.

De EDD REST API biedt een endpoint genaamd /reviews/. Het reviews-endpoint stelt je in staat de database te bevragen en een lijst met beoordelingen op te halen die op alle producten in je winkel zijn geplaatst. Een basisbevraging van beoordelingen ziet er als volgt uit:

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

Voor elke geretourneerde beoordeling ontvang je de volgende informatie:

• id – Het unieke ID van de beoordeling
• title – De titel van de beoordeling
• parent – Als de beoordeling een antwoord is, geeft dit de ID van de bovenliggende beoordeling
• download_id – De ID van de download waarvoor deze beoordeling is aangemaakt
• download_title – Titel van de download waarvoor deze beoordeling is aangemaakt
• rating – De beoordeling gegeven door de recensent. Dit is null voor een antwoord.
• author – De naam van de auteur van de beoordeling
• email – Het e-mailadres van de auteur van de beoordeling
• IP – Het IP-adres van waaruit de beoordeling is ingediend
• date – De datum waarop de beoordeling is ingediend
• date_gmt – De datum (in GMT) waarop de beoordeling is ingediend
• content – De inhoud van de beoordeling
• status – De status van de beoordeling. 1 staat voor goedgekeurd en 0 voor niet goedgekeurd (in afwachting). De status kan ook “spam” of “trash” zijn
• user_id – De WordPress gebruikers-ID van de auteur van de beoordeling
• type – Ofwel een beoordeling of een antwoord, afhankelijk van wat het is
• votes – Het aantal mensen dat heeft gestemd dat deze beoordeling nuttig of niet nuttig is. Dit is null voor een antwoord. Als dit een beoordeling is, heeft het sub-sleutels van yes en no

Een antwoord op een beoordelingsbevraging ziet er als volgt uit:

{
    "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
}

Bepaalde queryvariabelen kunnen aan de basisquery worden toegevoegd. Als je de gegevens voor een enkele beoordeling wilt ontvangen, kun je de parameter &review_id={identifier} toevoegen, zoals hier:

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

Het antwoord voor een enkele beoordeling ziet er als volgt uit:

{
    "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
}

Als je alle beoordelingen voor een enkele download wilt bekijken, kun je de parameter &download_id={identifier} toevoegen, zoals hier:

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

De bovenstaande query genereert een antwoord dat vergelijkbaar is met hierboven, maar met meerdere sub-sleutels onder de reviews-sleutel