Evaluation simplifiée d’une fiche
Objectif
Cette méthode permet de récupérer l’évaluation simplifié d’une fiche.
Format de réponse
Par défaut, l’API offre une réponse au format JSON. Pour bénéficier d’une réponse en XML, vous devez placer dans votre requête un header de type « Accept » avec la valeur « application/xml ».
Signature
GET https://api.monaviscompte.fr/ratings/:id?private_key=:private_key
Exemple : https://api.monaviscompte.fr/ratings/794173?private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
id | oui | int | identifiant de la fiche |
private_key | oui | string | clé d’authentification privée |
Données retournées
nom | type | description |
---|---|---|
grade | float | la note de la fiche entre 0 et 5 |
all_reviews_count | int | le nombre d’avis déposés sur la fiche |
click_to_review | string | le lien permettant le dépôt d’avis express depuis votre site, les réseaux sociaux, une campagne emailing. L’URL retournée est relative à la version de monaviscompte que vous utilisez (probablement https://www.monaviscompte.fr/) |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
HTTP 404 | la fiche n’existe pas |
Réponse JSON
{
"grade"
: 3.9,
"all_reviews_count"
: 342,
"click_to_review"
:
"depot-express-avis/a22k-hjq9-hkp5-32cb/1082"
}
Réponse XML
<
rating
>
<
all_reviews_count
>342</
all_reviews_count
>
<
click_to_review
>
depot-express-avis/a22k-hjq9-hkp5-32cb/1082
</
click_to_review
>
<
grade
>3.9</
grade
>
</
rating
>