Daten-API
Die API öffnet, sobald ihr Datenspeicher in Betrieb ist. Schlüssel werden noch nicht ausgestellt.
Stand
Die API liefert noch keine Daten. Bis sie öffnet, wird jede Anfrage abgelehnt, es werden keine Schlüssel ausgestellt, und man kann sich nicht darauf verlassen, dass etwas auf dieser Seite funktioniert. Diese Seite beschreibt, was künftig angeboten wird.
Was die API ist
Ein Endpunkt pro Vergleich (mobile, internet, tv, phone). Er liefert die Angebote, die meconomy.ch mit gespeichertem Beleg zeigt, jeweils mit ihrer Quelle und der Angabe in evidence.reader, wer sie erfasst hat: parser (MEconomyBot, von der eigenen Seite des Anbieters), official (eine amtliche Quelle) oder human (eine Person bei einer begleiteten Erfassung).
Nicht enthalten: Preise, die wir von Hand führen, andere Vergleiche, der eigene Text des Anbieters und die gespeicherten Belegdateien. Ist eine Angabe nicht genannt, ist das Feld null; das heisst «nicht angegeben», nicht «keine».
Einen Schlüssel erhalten
Fragen Sie über die Kontaktseite an, mit dem Thema «API-Schlüssel», und nennen Sie die Organisation oder das Projekt sowie den Zweck. Schlüssel sind kostenlos und werden von MEconomy ausgestellt. Pro Organisation oder Projekt wird ein Schlüssel ausgestellt.
Halten Sie den Schlüssel geheim und auf einem Server. Anfragen aus einer Browserseite werden nicht unterstützt: Die API sendet keine CORS-Header, und ein Schlüssel im Seitencode ist für alle sichtbar, die die Seite öffnen.
Anfrage
Senden Sie eine GET-Anfrage mit dem Schlüssel im Header Authorization. Der einzige Parameter ist provider, optional, ein Anbieter-Slug. Ein Schlüssel in der Adresse wird abgelehnt.
Antwort
Die Form einer Antwort, jedes Feld mit seinem Typ; das Beispiel enthält keinen Wert. Der Inhalt hat das Format meconomy-offers-v1, den Zeitpunkt der Erzeugung, die Zahl der Angebote, die Zahl der zurückgehaltenen Angebote, weil ein Datensatz unsere Prüfungen nicht bestanden hat, die Lizenz und den Geltungsbereich.
Limiten
- 600 Aufrufe pro Tag und Schlüssel. Die Zählung beginnt um 00:00 UTC neu.
- Die Antworten 200 und 429 enthalten
RateLimit-Limit,RateLimit-RemainingundRateLimit-Reset(Sekunden bis zum Neubeginn); andere Fehlerantworten nicht. - Ist das Limit aufgebraucht, lautet die Antwort 429 mit
Retry-After.
Fehler
Ein Fehler hat die Form {"error": {"code": "…", "message": "…"}} mit dem unten stehenden Status.
Lizenz und Namensnennung
Die Daten stehen unter der Lizenz CC BY 4.0. Nennen Sie «MEconomy, meconomy.ch» mit einem Link auf https://meconomy.ch, wo immer Sie die Daten zeigen. Preise sind Tatsachen, wie wir sie zum genannten Zeitpunkt erfasst haben; sie können sich jederzeit ändern, und massgebend ist die eigene Seite des Anbieters. Keine Gewährleistung. Wir können einen Schlüssel widerrufen, der weitergegeben, weiterverkauft oder über sein Limit hinaus genutzt wird.
Ihre Daten
Pro Schlüssel speichern wir den Namen der Organisation oder des Projekts, eine Kontakt-E-Mail-Adresse, den genannten Zweck und die tägliche Anzahl Aufrufe pro Vergleich; keine IP-Adresse und keinen Inhalt der Anfragen. Wir bewahren sie auf, solange der Schlüssel aktiv ist. 12 Monate nachdem ein Schlüssel widerrufen wurde, löschen wir den Namen, die Kontakt-E-Mail-Adresse und den Zweck; die täglichen Zahlen bleiben. Mehr in der Datenschutzerklärung.
Änderungen
Version 1 erhält nur zusätzliche Felder. Eine Änderung, die ein Feld entfernt oder umbenennt, wird zu Version 2 und 90 Tage vorher auf dieser Seite angekündigt.