API de données
L’API ouvrira une fois sa base de données en service. Aucune clé n’est encore délivrée.
État
L’API ne fournit pas encore de données. Tant qu’elle n’est pas ouverte, toute requête est refusée, aucune clé n’est délivrée et rien de ce qui figure sur cette page n’est assuré de fonctionner. Cette page décrit ce qui sera proposé.
Ce que c’est
Un point d’accès par comparaison (mobile, internet, tv, phone). Il renvoie les offres que meconomy.ch affiche avec une preuve conservée, chacune avec sa source et le lecteur indiqué dans evidence.reader : parser (MEconomyBot, depuis la page du fournisseur), official (une source officielle) ou human (une personne lors d’un relevé accompagné).
Non inclus : les prix saisis à la main, les autres comparaisons, le texte propre du fournisseur et les fichiers de preuve conservés. Lorsqu’un chiffre n’est pas indiqué, le champ vaut null, ce qui signifie « non indiqué », et non « aucun ».
Obtenir une clé
Demandez-la par la page de contact avec le sujet « Clé API », en indiquant l’organisation ou le projet et l’usage prévu. Les clés sont gratuites et délivrées par MEconomy. Une clé est délivrée par organisation ou par projet.
Gardez la clé secrète et sur un serveur. Les requêtes depuis une page de navigateur ne sont pas prises en charge : l’API n’envoie aucun en-tête CORS, et une clé dans le code d’une page est visible de toute personne qui ouvre la page.
Requête
Envoyez une requête GET avec la clé dans l’en-tête Authorization. Le seul paramètre est provider, facultatif, un slug de fournisseur. Une clé dans l’adresse est refusée.
Réponse
La forme d’une réponse, chaque champ étant indiqué par son type ; l’exemple ne contient aucune valeur. Le corps a le format meconomy-offers-v1, l’heure de génération, le nombre d’offres, le nombre d’offres écartées parce qu’un enregistrement n’a pas passé nos contrôles, la licence et le périmètre.
Limites
- 600 appels par jour et par clé. Le compteur repart à 00:00 UTC.
- Les réponses 200 et 429 portent
RateLimit-Limit,RateLimit-RemainingetRateLimit-Reset(secondes jusqu’à la remise à zéro) ; les autres erreurs n’en portent pas. - Lorsque la limite est atteinte, la réponse est 429 avec
Retry-After.
Erreurs
Une erreur a la forme {"error": {"code": "…", "message": "…"}} avec le statut ci-dessous.
Licence et mention de la source
Les données sont sous licence CC BY 4.0. Mentionnez « MEconomy, meconomy.ch » avec un lien vers https://meconomy.ch partout où vous les affichez. Les prix sont des faits tels que nous les avons relevés au moment indiqué ; ils peuvent changer à tout instant, et la page du fournisseur fait foi. Aucune garantie. Nous pouvons révoquer une clé partagée, revendue ou utilisée au-delà de sa limite.
Vos données
Pour chaque clé, nous conservons le nom de l’organisation ou du projet, une adresse e-mail de contact, l’usage indiqué et un décompte quotidien des appels par comparaison ; aucune adresse IP et aucun contenu de requête. Nous les conservons tant que la clé est active. 12 mois après la révocation d’une clé, nous effaçons le nom, l’adresse e-mail de contact et l’usage ; les décomptes quotidiens restent. Plus de détails dans la déclaration de protection des données.
Modifications
La version 1 ne fait que gagner des champs. Une modification qui en supprime ou en renomme un devient la version 2, annoncée sur cette page 90 jours à l’avance.