Liste des fiches
Objectif
Cette méthode permet de récupérer l’ensemble de vos 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/items?private_key=:private_key
Exemple : https://api.monaviscompte.fr/items?private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
private_key | oui | string | clé d’authentification privée |
name | non | string | agit comme un filtre sur le nom des fiches retournées |
Données retournées
nom | type | description |
---|---|---|
my_items | list | liste de vos fiches |
my_items_count | int | nombre de fiches que vous possédez |
Les éléments item sont composés des valeurs suivantes :
nom | type | description |
---|---|---|
id | int | identifiant de la fiche |
name | string | nom de la fiche |
url | string | URL relative de la fiche |
brand | string | nom de la marque à laquelle est associée la fiche |
picture | string | URL de l’image de la fiche |
family | string | famille de la fiche, parmi product, retailer, website, service ou brand |
summary | string | description de la fiche |
reviews_count | int | nombre d’avis déposés sur la fiche |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
Réponse JSON
{
"my_items"
: [
{
"id"
:
"794172"
,
"name"
:
"Mon petit dressing - PDV"
,
"summary"
:
"Marque de mode commercialisant des vêtements"
,
"brand"
:
"Mon Petit Dressing"
,
"picture"
: "https://s3-eu-west-1.amazonaws.com/s3.monaviscompte.fr/item/1239240-7771214672345201_monpetitdressing-com.jpg",
"family"
: "retailer",
"url"
: "avis-consommateur/mon-petit-dressing---pdv-794172",
"reviews_count"
: "26"
},
{
"id"
:
"794173"
,
"name"
:
"monpetitdressing.com"
,
"summary"
:
"Marque de mode commercialisant des vêtements"
,
"brand"
:
"Mon Petit Dressing"
,
"picture"
: "https://s3-eu-west-1.amazonaws.com/s3.monaviscompte.fr/item/1239240-7771214672345201_monpetitdressing-com.jpg",
"family"
: "website",
"url"
: "avis-consommateur/monpetitdressing-com-794173",
"reviews_count"
: "25"
}
],
"my_items_count"
: "2"
}
Réponse XML
<
items
>
<
my_items
>
<
item
>
<
name
>Mon petit dressing - PDV</name>
<url>avis-consommateur/mon-petit-dressing---pdv-794172</url>
<id>794172</id>
<brand>Mon Petit Dressing</brand>
<picture>https://s3-eu-west-1.amazonaws.com/s3.monaviscompte.fr/item/1239240-7771214672345201_monpetitdressing-com.jpg</picture>
<family>retailer</family>
<reviews_count>26</reviews_count>
<summary>Marque de mode commercialisant des vêtements</summary>
</
item
>
<
item
>
<name>monpetitdressing.com</name>
<url>avis-consommateur/monpetitdressing-com-794173</url>
<id>794173</id>
<brand>Mon Petit Dressing</brand>
<picture>https://s3-eu-west-1.amazonaws.com/s3.monaviscompte.fr/item/1239240-7771214672345201_monpetitdressing-com.jpg</picture>
<family>website</family>
<reviews_count>25</reviews_count>
<summary>Marque de mode commercialisant des vêtements</summary>
</
item
>
</
my_items
>
<
my_items_count
>2</
my_items_count
>
</
items
>