Avis – REST API

Les avis s'intègrent à l'API REST EDD vous permettant de récupérer les avis au format JSON ou XML.

L'API REST EDD fournit un point de terminaison appelé /reviews/. Le point de terminaison des avis vous permet d'interroger la base de données et de récupérer une liste d'avis placés sur tous les produits de votre boutique. Une requête d'avis de base ressemble à ceci :

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

Pour chaque avis retourné, vous recevrez les informations suivantes :

• id – L'ID unique de l'avis
• title – Le titre de l'avis
• parent – Si l'avis est une réponse, ceci donne l'ID de l'avis parent
• download_id – L'ID du téléchargement pour lequel cet avis a été créé
• download_title – Le titre du téléchargement pour lequel cet avis a été créé
• rating – La note donnée par l'évaluateur. Ce sera null pour une réponse.
• author – Le nom de l'auteur de l'avis
• email – L'adresse e-mail de l'auteur de l'avis
• IP – L'adresse IP depuis laquelle l'avis a été soumis
• date – La date à laquelle l'avis a été soumis
• date_gmt – La date (en GMT) à laquelle l'avis a été soumis
• content – Le contenu de l'avis
• status – Le statut de l'avis. 1 représente approuvé et 0 représente non approuvé (en attente). Le statut peut aussi être « spam » ou « trash »
• user_id – L'ID utilisateur WordPress de l'auteur de l'avis
• type – Soit un avis, soit une réponse, selon ce que c'est
• votes – Le nombre de personnes qui ont voté que cet avis est utile ou inutile. Ce sera null pour une réponse. S'il s'agit d'un avis, il aura des sous-clés de yes et no

Une réponse de requête d'avis ressemble à ceci :

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

Certaines variables de requête peuvent être jointes à la requête de base. Si vous souhaitez recevoir les données d'un seul avis, vous pouvez ajouter le paramètre &review_id={identifier}, comme ceci :

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

La réponse pour un seul avis ressemble à ceci :

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

Si vous souhaitez afficher tous les avis pour un seul téléchargement, vous pouvez ajouter le paramètre &download_id={identifier}, comme ceci :

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

La requête ci-dessus générera une réponse similaire à celle ci-dessus, mais elle aura plusieurs sous-clés sous la clé reviews