Evaluation simplifiée de plusieurs fiches
Objectif
Cette méthode permet de récupérer l’évaluation simplifiée de plusieurs fiches.
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?ids=:ids&private_key=:private_key
Exemple : https://api.monaviscompte.fr/ratings?ids=794173,794176&private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
ids | oui | list<int> | identifiants des fiches, séparés par une virgule |
private_key | oui | string | clé d’authentification privée |
Données retournées
La méthode renvoie une liste ratings contenant les champs suivants. Cette liste est de la même taille que le nombre d’identifiants fournis, avec comme valeur null pour les fiches inexistantes.
nom | type | description |
---|---|---|
grade | float | la note de la fiche entre 0 et 5 |
all_review_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 400 | mauvais format des ids |
Réponse JSON
{
"ratings"
: [
{
"grade"
: 3.9,
"all_reviews_count"
: 342,
"click_to_review"
:
"depot-express-avis/a22k-hjq9-hkp5-32cb/1082"
},
{
"grade"
: 3.8,
"all_reviews_count"
: 358,
"click_to_review"
:
"depot-express-avis/a22k-hjq9-hkp5-32cb/1084"
}
]
}
Réponse XML
<
ratings
>
<
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
>
<
rating
>
<
all_reviews_count
>358</
all_reviews_count
>
<
click_to_review
>depot-express-avis/a22k-hjq9-hkp5-32cb/1084</
click_to_review
>
<
grade
>3.8</
grade
>
</
rating
>
</
ratings
>