API publique

Enrichissez vos applications en accédant à la base de données de produits Prixing

Prixing met à votre disposition une API REST sur sa base de produits

Pour quoi faire?

L'API Prixing vous permet d'accéder à la base de données des produits de manière programmatique. Vous pouvez ainsi enrichir vos applications avec ce contenu, ou répondre à divers besoins simples de compilations de données.

Notre objectif est de permettre la création d'un écosystème applicatif autour de notre base de données. Dans le domaine du shopping il existe un nombre infini de fonctionnalités que l'on peut mettre en place, et Prixing n'a pas pour vocation de répondre à 100% des besoins.
En ouvrant notre base aux développeurs, nous espérons ainsi voir fleurir des applications intéressantes qui utiliseront nos données de façon originale.

Quel usage?

Via notre API, un site de cuisine pourrait déterminer une liste de courses à partir des recettes choisies, une application orientée santé/diététique pourrait calculer les apports journaliers d'un repas à partir de ses composantes, un site high tech pourrait comparer les caractéristiques de divers produits...

La limite se situe au niveau de l'imagination des développeurs!

Fonctionnalités de l'API

Pour l'instant, l'API (v1.0 bêta) ne propose qu'un nombre limité de fonctionnalités. Dans un premier temps, seule la recherche de produits à partir du code EAN est disponible.

La réponse sur un produit comprend comme informations:

• titre
• marque/fabricant
• référence
• image
• propriétés (sous la forme clé/valeur)

Nous rajouterons petit à petit les appels suivants:

• recherche par mot clé
• recherche par catégorie
• recherche par marque
• recherche par critère (additif, label, ingrédient, poids/volume, caractéristique précise...)
• avis et notes sur les produits (anonymisé)
• accès au flux de scan temps réel (anonymisé)
• ...

Nous étudierons toutes les demandes des développeurs au fur et à mesure. Aucune donnée personnelle, géolocalisée, ou liée à un quelconque utilisateur ne sera transmise. La base magasin ainsi que la base de prix ne seront pas accessibles par l'API publique.

Comment y accéder?

Vous devez vous connecter via votre compte Prixing, puis remplir le formulaire de demande de clé API.

Conditions d'utilisations

Conditions d'accès à l'API publique et limitations

Conditions d'accès

L'accès à l'API est ouvert à tout le monde de manière gratuite, dans la limite d'utilisation des quotas attribués. Afin de pouvoir envoyer des requêtes sur l'API, l'obtention d'une clé est nécessaire.

Les quotas d'utilisation de base sont les suivants:

• 50 requêtes par jour (une fois le compte validé) (gratuit)
• 30 000 requêtes par mois nous contacter
• 100 000 requêtes par mois nous contacter

Conditions d'utilisations

En dehors des éventuels besoins ponctuels de caching, vous n'êtes pas autorisé à copier les données de produits sur votre serveur dans le but de dupliquer la base. D'une manière générale, toute utilisation de l'API dans le but de constituer une copie de notre base de données est interdit.

Limites & Responsabilités

Durant la phase bêta, la disponibilité de l'API n'est pas garantie. Nous ferons le maximum pour assurer un service de la meilleure qualité possible, mais sans engagement de résultat.

Les contenus distribués sont dans le domaine public et ne disposent pas de copyright. En cas de contestation, Prixing SAS s'engage à supprimer immédiatement les contenus incriminés.

Prixing SAS n'est en aucun cas responsable de la validité et de la pertinence des données transmises par l'API.

Clé API

Obtenir une clé API

Merci de décrire en quelques mots votre projet d'application avec l'API. Une fois approuvé, votre compte sera crédité du quota de 500 requêtes par jour (nous avons du mettre en place ce système de vérification suite à des abus, merci de votre compréhension)

Attention: votre compte Prixing doit être valide!

Documentation

Introduction

Clé API

Tout appel à l'API doit se faire en passant le paramètre key qui contient votre clé API.

Format des données

Les réponses de l'API sont au format JSON encodés en UTF8.

Base de l'API

La racine de l'API est:

http://www.prixing.fr/api/v1/

Codes d'erreur

Si la requête est mal formattée, le code 400 est retourné:

{
    "code": 400,
    "erreur": "Requête invalide"
}

Si la clé API n'est pas valide, le code 401 est retourné:

{
    "code": 401,
    "erreur": "Clé API invalide"
}

Si votre quota de requête est dépassé, le code 402 est retourné:

{
    "code": 402,
    "erreur": "Quota dépassé"
}

Si votre IP ou clé n'est pas autorisée, le code 403 est retourné:

{
    "code": 403,
    "erreur": "Non autorisé"
}

Documentation

Méthode /ean

Si vous connaissez le code EAN (gencode) du produit qui vous intéresse, vous pouvez récupérer sa fiche produit au format JSON avec la requête suivante: http://www.prixing.fr/api/v1/ean/<code_ean>?key=<votre_cle> Exemple de réponse pour le code EAN 3017624044003 (Nutella 400g):

{
    "code": 200,
    "produit": {
        "titre": [
            "PATE A TARTINER NUTELLA 400G",
            "Pâte à tartiner",
            "Nutella , 400g",
            "Nutella Pâte à tartiner 400g",
            "Pâte à tartiner aux noisettes, lait écrémé",
            "Pâte à tartiner Nutella, 400g"
        ],
        "marque": [
            "NUTELLA",
            "Ferrero"
        ],
        "image": {
            "width": "350",
            "url": "http://www.prixing.fr/img/p/22/3017624044003_L.jpg",
            "height": "350"
        },
        "proprietes": {
            "Ingredients": "Sucre, huile végétale, noisettes (13%), cacao maigre 
            (7,4%), lait écrémé en poudre (6,6%), lactosérum en poudre, 
            émulsifiant (lécithine de soja), arôme Sans colorant ni conservateur.",
            "Valeur energetique": "Pour 100g : 530 kcal (2215 kJ), protéïnes : 
            6,8g, glucides : 56g, lipides : 31g.",
            "Renseignements pratiques": "Nutella est à base d'ingrédients naturels 
            et justement dosés. Petit déjeuner Nutella équilibré : 2 tartines de 
            pain et de Nutella, 1 bol de lait et 1 verre de jus d'orange. Goûter 
            Nutella équilibré : 1 tartine de pain et de Nutella, 1 yaourt nature.",
            "Informations": "Sur du pain au petit-déjeuner et au goûter ou sur des 
            crêpes pendant la chandeleur, Nutella accompagne toute la famille pour 
            des moments de plaisir ! Produit mythique à la recette inégalée, 
            Nutella accompagne les petits déjeuners et goûters de millions de 
            français depuis 1965. Preuve de l'attachement des familles à la marque, 
            la France est devenue le premier marché mondial pour Nutella avec plus 
            de 100 millions de pots consommés en 2008. Une des marques phares du 
            Groupe Ferrero et la marque alimentaire préférée des français."
        }
    }
}

Exemple de réponse pour le code EAN 3068320052007 (Evian 2L):

{
    "code": 200,
    "produit": {
        "titre": [
            "Evian eau minérale 2l",
            "Eau minérale naturelle",
            "EAU MINERALE EVIAN 2L"
        ],
        "marque": [
            "Evian"
        ],
        "image": {
            "width": "350",
            "url": "http://www.prixing.fr/img/p/2/3068320052007_L.jpg",
            "height": "350"
        },
        "proprietes": {
            "Mineralisation": {
                "pH": "7.2",
                "Résidu sec à 180°C (mg/l)": "309"
            },
            "Ingredients": "Minéralisation en mg/l : calcium : 80, magnésium : 26, 
            sodium : 6,5, potassium : 1, silice : 15, bicarbonates : 360, 
            sulfates : 12,6, chlorures : 6,8, nitrates : 3,7 
            Résidu sec à 180°C : 309mg/l pH : 7,2.",
            "Valeur energetique": "Calcium : 80mg/l, magnésium : 26 mg/l, 
            sodium : 6,5, potassium : 1mg/l, silice : 15mg/l, bicarbonates : 360mg/l, 
            sulfates : 12,6mg/l, chlorures : 6,8mg/l, nitrates : 3,7mg/l.",
            "Renseignements pratiques": "Filtrée pendant plus de 15 ans à travers 
            les sables glaciaires des Alpes, l'eau d'Evian, jour après jour, 
            s'enrichit en sels minéraux indispensables à la vie. Consommée chaque 
            jour, elle facilite l'élimination des déchets sans fatiguer l'organisme. 
            L'eau d'Evian est reconnue favorable à la santé par l'Académie 
            Nationale de Médecine.",
            "Informations": "Evian est une eau minérale naturelle, reconnue 
            favorable à la santé par l'Académie Nationale de Médecine. Evian apporte 
            au corps humain la pureté et l'équilibre dont il a besoin pour être au 
            mieux de ses possibilités aujourd'hui et demain. L'eau d'Evian est 
            recommandée pour l'alimentation du bébés. L'eau d'Evian convient à 
            tous les régimes alimentaires et peut être consommée tout au long de 
            la journée. Evian 2l le format pour toute la famille.",
            "Composition en mg/l": "Calcium : 78 Magnésium : 24 Sodium : 5 
            Potassium : 1 Bicarbonates : 357 Sulfates : 10 Chlorures : 4,5 
            Nitrates : 3,8 Silice : 13,5 Résidu sec à 180°C : 309mg/l pH : 7,2",
            "Composition": {
                "Silice": "13,5 ",
                "Magnésium": "24",
                "Fluor": "-",
                "Sulfate": "10",
                "Calcium": "78",
                "Chlorure": "4,5",
                "Minéraux et oligo-éléments en mg/litre": "",
                "Bicarbonates": "357",
                "Nitrates": "3,8",
                "Sodium": "5",
                "Potassium": "1"
            }
        }
    }
}

Exemple de réponse pour le code EAN 8808993631377 (Ecran LCD Samsung):

{
    "code": 200,
    "produit": {
        "titre": [
            "Samsung SyncMaster LD220HD - Écran LCD - TFT - 21.5\\\" - écran 
            large - 1920 x 1080 - 300 cd/m2 - 1000:1 - 50000:1 (dynam",
            "Moniteur LCD SAMSUNG SyncMaster LD220HD TNT intégrée 21.5'' - 
            Personnaliser-le à prix réduit grâce à Samsung",
            "Ecran SAMSUNG LD220HD",
            "Samsung - SyncMaster LD220HD - Moniteur LCD 22\\\" - VGA / DVI 
            - Tuner TNT HD -...",
            "SyncMaster LD220HD - SAMSUNG - Moniteur LCD"
        ],
        "marque": [
            "Samsung"
        ],
        "reference": [
            "LS22FMDGF/EN",
            "LD220HD",
            "843899"
        ],
        "image": {
            "url": "http://img.netaffiliation.com/p/4/12/photo_11117184813g"
        },
        "proprietes": {
            "Traitement et reception": {
                "Tuner TNT": "Haute Définition "
            },
            "Consommations": {
                "Consommation (en veille)": "2 Watts",
                "Consommation (en fonctionnement)": "46 watts"
            },
            "Support et fixation": {
                "Support de table": "Inclinable"
            },
            "Divers": {
                "Caractéristiques : ": "Montage mural possible ",
                "Conformité aux normes : ": "DDC-2B ",
                "Certified for Windows Vista : ": "Les appareils et logiciels 
                Certified for Windows Vista ont subi des tests de compatibilité 
                Microsoft pour optimiser les performances et renforcer la sécurité. "
            },
            "Entree video": {
                "Vidéo supportée : ": "RGB ",
                "Norme de vidéo numérique : ": "Digital Visual Interface, 
                High-Definition Multimedia Interface (HDMI) ",
                "Accès Conditionnel : ": "Logement CI (Common Interface) "
            },
            "Les points cles": {
                "Type": "Moniteur",
                "Résolution": "HDTV 1080p",
                "Taille de l'écran": "de 51 à 60 cm",
                "Technologie du tuner": "TNT Haute Définition",
                "Technologie": "LCD"
            },
            "Alimentation": {
                "Facteur de forme : ": "Interne ",
                "Consommation en fonctionnement : ": "46 Watt ",
                "Consommation en veille / sommeil : ": "2 Watt "
            },
            "Poids et Dimensions": {
                "Largeur": "34 cm",
                "Hauteur (avec pied)": "52 cm",
                "Profondeur (sans pied)": "6 cm",
                "Profondeur (avec pied)": "8 cm",
                "Poids (avec pied)": "4,4 kg",
                "Hauteur (sans pied)": "34 cm"
            },
            "Ecran et Traitement Video": {
                "Luminosité": "300 cd/m²",
                "Format": "16/9",
                "Temps de réponse": "5 ms",
                "Taux de contraste": "jusqu'à 50000:1",
                "Taille de l'écran": "21,5 pouces",
                "Angle de vue": "170 °",
                "Résolution native": "1920 x 1080 pixels",
                "Technologie": "LCD"
            },
            "Ecran": {
                "Luminosité": "300 cd/m²",
                "Format": "16/9 ",
                "Temps de réponse": "5 ms",
                "Taux de contraste": "jusqu'à 50000:1 ",
                "Taille de l'écran": "21.5 pouces",
                "Angle de vue": "170 °",
                "Résolution native": "1920 x 1080 pixels ",
                "Technologie": "LCD "
            },
            "Integration": {
                "Support de table": "Inclinable "
            },
            "Affichage": {
                "Format vidéo : ": "1080p ",
                "Résolution maxi : ": "1920 x 1080 ",
                "Temps de réponse : ": "5 ms ",
                "Angle d'inclinaison : ": "20 ",
                "Diagonale : ": "21.5\\\" - écran large ",
                "Réglages des positions d'écran : ": "Inclinaison ",
                "Entrée de signal : ": "HDMI, DVI-I, VGA ",
                "Prise en charge des couleurs : ": "24 bits (16,7 millions de 
                couleurs) ",
                "Fonctions : ": "Dolby Digital Plus, SRS TruSurround HD "
            },
            "Extension/connectivite": {
                "Interfaces : ": "1 x VGA - HD D-Sub (HD-15) 15 broches ¦ 1 x DVI-I 
                - DVI combiné 29 broches ¦ 1 x HDMI - HDMI type A 19 broches ¦ 
                1 x SCART - SCART 21 broches ¦ 1 x entrée vidéo composante - 
                RCA ¦ 1 x entrée ligne audio - RCA ¦ 1 x casque - 
                fiche mini-phone Stéréo 3,5 mm "
            },
            "Dimensions": {
                "Hauteur (avec pied)": "51.7 ",
                "Largeur": "34 ",
                "Profondeur (sans pied)": "6.3 ",
                "Poids (avec pied)": "4.4 kg",
                "Profondeur (avec pied)": "7.6 ",
                "Hauteur (sans pied)": "34 "
            },
            "General": {
                "Dispositifs intégrés : ": "Haut-parleurs stéréo, tuner DVB-T ",
                "Type d'affichage : ": "Écran LCD / matrice active TFT ",
                "Poids : ": "4.5 kg ",
                "Largeur : ": "51.7 cm ",
                "Couleur du boîtier : ": "Noir brillant ",
                "Hauteur : ": "34 cm ",
                "Profondeur : ": "7.7 cm "
            },
            "Confort et utilisation": {
                "Fonctionnalités :": "Mode hôtel "
            },
            "Image": {
                "Angle maximum de vision verticale : ": "160 ",
                "Luminosité d'image : ": "300 cd/m2 ",
                "Angle maximum de vision horizontale : ": "170 ",
                "Rapport de contraste d'image : ": "1000:1 / 50000:1 (dynamique) "
            },
            "Contenu du carton": {
                "Livré avec": "Notice, Télécommande, Câble VGA, Alimentation 
                MagicBright3 "
            },
            "Reception": {
                "Tuner TNT": "Haute Définition"
            },
            "Sortie audio": {
                "Type : ": "Haut-parleur(s) - stéreo "
            },
            "Son": {
                "Puissance des haut-parleurs": "Pas de haut-parleur intégré "
            },
            "Connectique": {
                "Détail :": "Péritel: 1, Composite: 1, Composante (yuv): 1, 
                HDMI: 1, Audio analogique: 1, Prise casque: 1 "
            }
        }
    }
}

Le format de réponse contient les éléments suivants: "code": 200
un résultat a été trouvé "titre": [ ... ]
un tableau contenant les titres connus pour le produit "marque": [ ... ]
un tableau contenant les marques connues pour le produit "reference": [ ... ]
un tableau contenant les références connues pour le produit

"image" : {
            "width": "350",
            "url": "http://www.prixing.fr/img/p/2/3068320052007_L.jpg",
            "height": "350"
        }
url de l'image, ainsi que sa taille quand elle est connue

Si le code EAN est inconnu, le code erreur 404 est retourné:

{
    "code": 404,
    "erreur": "EAN inconnu"
}

Si le code EAN est invalide, le code erreur 415 est retourné:

{
    "code": 415,
    "erreur": "EAN invalide"
}