• Hallo Gast, wir suchen den Renner der Woche - vielleicht hast du ein passendes Rennrad in deiner Garage? Alle Infos

Ankündigung: Winterpokal API

rik

Administrator
Administrator
Wir werden ab dieser Saison einige Funktionen des Winterpokals per HTTP-API anbieten.

Damit ist es möglich neue Einträge hinzuzufügen und Daten aus dem Winterpokal auszulesen um sie z. B. auf anderen Websites weiterzuverarbeiten oder eine Mobile App zu bauen.

Wir haben den Grundstein gelegt, die ersten Funktionen sind implementiert.

Um einen Eindruck zu bekommen, kann sich jeder Interessierte die API-Dokumentation anschauen: https://github.com/mtb-news/Winterpokal-API/wiki

Unsere Bitte an euch: Schreibt uns hier, welche Funktionen ihr von so einem API erwartet - wenn sie uns sinnvoll erscheinen und keinen zu großen Aufwand bedeuten werden wir sie gerne einbauen!

(In der Dokumentation ist von mtb-news.de die Rede, ersetzt das in Gedanken einfach mit rennrad-news.de - die Funktionen sind identisch!)

-rik
 

c930

MItglied
AW: Ankündigung: Winterpokal API

Hi,

ich mache aktuell eine kleine iOS App mit der alten Trainingsverwaltuns-API. Wird diese durch die neue ersetzt bzw. wird man mit der neuen Api auch Einheiten in die Trainingsverwaltung eintragen können? Oder sind Winterpokal und Trainingsverwaltung jetzt nicht mehr integriert?

Ein ganz wichtiger Punkt für mich ist der Aufruf über https. Gerade mobile Apps sind sonst ein Sicherheitsrisiko.

Es sollte auch per POST möglich sein, mit den Userdaten den API-Key zu bekommen. Aktuell parse ich mir den aus dem HTML der Trainingsverwaltung raus...
 

rik

Administrator
Administrator
AW: Ankündigung: Winterpokal API

Ok, viele Fragen ;)

- die alte API der Trainingsverwaltung wird erst mal noch bleiben, daran wird aber nichts mehr erweitert.
- es wird eine neue API geben, welche im Stil der Winterpokal-API daher kommen wird.
- HTTPS-Support ist in Planung
- Die Möglichkeit, an den Key zu kommen, werden wir einbauen.
 

c930

MItglied
AW: Ankündigung: Winterpokal API

OK, sehr schön! :)

Aktuell kann man wohl auch im Web-Interface keine Einheiten löschen?

Werde mir dann einen Test-Account außer Konkurrenz anlegen.

Aktuell (kurz nach Mitternacht) lässt sich per Api noch nichts hinzufügen: "Datum außerhalb des gültigen Zeitraumes". Per Web-Interface geht es.
 

rik

Administrator
Administrator
AW: Ankündigung: Winterpokal API

Löschen kommt noch (Webinterface und API). Den Bug schau ich mir kurz noch an.
 

rik

Administrator
Administrator
AW: Ankündigung: Winterpokal API

Du hattest '2011-11-06' als Datum angegeben, daher ging es nicht ;)
 

wildspitze

Aktives Mitglied
AW: Ankündigung: Winterpokal API

Feine Sache mit der API. :) Wir nutzen die WP-Daten ja schon seit einigen Jahren in der IBL für unsere Mitglieder.

Bin gerade dabei, die ersten Funktionen auf die API umzustellen. Ad hoc fehlen mir zwei Features. Wäre fein, wenn ihr das noch implementieren könntet.

Zum einen eine zusätzliche Ausweisung der Gesamtpunktzahl beim Abruf des Team-Rankings, hier rot markiert:

Code:
{
    "status": "OK",
    "messages": [],
    "data": [{
        "ranking": {
            "position": 1,
            "preweek": 1
        },
        "team": {
            "id": "93",
            [COLOR="Red"]"points": "222",[/COLOR]
            "name": "KTWR goes race around the clock Team I",
            "url": "http:\/\/winterpokal-local.mtb-news.de\/\/teams\/view\/93"
        }
    },
    {
        "ranking": {
            "position": 2,
            "preweek": 2
        },
        "team": {
            "id": "131",
            [COLOR="Red"]"points": "215",[/COLOR]
            "name": "biehler-procycle.de",
            "url": "http:\/\/winterpokal-local.mtb-news.de\/\/teams\/view\/131"
        }
    }]
}
Zum anderen wäre mir eine zusätzliche API-Funktion lieb, mir der ich prüfen kann, ob ein bestimmter Nickname im WP gelistet ist. Momentan checke ich das über ein Parsen der Seite http://winterpokal.rennrad-news.de/users/search?name=<Nickname>, um die User-ID zu ermitteln.

Sage vorab schon einmal Danke. ;)
 

c930

MItglied
AW: Ankündigung: Winterpokal API

Finde auch, dass die Api gut funktioniert. Tolle Arbeit! :)

Folgende Wünsche sind mir noch eingefallen:

- Eigene userID (Imho kann man die aktuell nur über die my.json bekommen, wenn der User bereits einen Eintrag hat, oder?)

- Eine Funktion, den aktuellen Api-Key zu löschen

- Anzahl der eigenen Api-Requests pro Zeitraum (Gibt es hier ein Maximum? Wenn ja, sollte man das auch abfragen können)

- Statistik-Daten (Anzahl Einträge Gesamt pro Zeiteinheit, Anzahl aktive User... )

Nur schade, dass so wenige User ein Avatar gepflegt haben, das versaut mir die UI... ;)
 

wildspitze

Aktives Mitglied
AW: Ankündigung: Winterpokal API

Bei der Abfrage des Rankings über die API und Angabe eines Filters (z.B. 'alternative_sportarten') werden m.E. falsche Angaben zurückgegeben. Das Ranking ist korrekt, Points und Duration werden allerdings als Total, also für alle Sportarten, berechnet.

Ist das so gewollt? Finde es sinnvoller, wenn sich ausgewiesene Punkte und Dauer nur auf den Filter beziehen.
 

rik

Administrator
Administrator
AW: Ankündigung: Winterpokal API

Bei der Abfrage des Rankings über die API und Angabe eines Filters (z.B. 'alternative_sportarten') werden m.E. falsche Angaben zurückgegeben. Das Ranking ist korrekt, Points und Duration werden allerdings als Total, also für alle Sportarten, berechnet.

Ist das so gewollt? Finde es sinnvoller, wenn sich ausgewiesene Punkte und Dauer nur auf den Filter beziehen.
Bug ist gefixt!
 

c930

MItglied
AW: Ankündigung: Winterpokal API

Ich könnte noch folgendes gebrauchen:

- Das Ranking eines Users für die Funktionen unter /entries/
- Einen Start-Parameter für die Funktionen unter /entries/
- Auch das Team sollte unter /entries/ zurück gegeben werden


Beides ist unter /user_ranking/ schon vorhanden.
 

c930

MItglied
AW: Ankündigung: Winterpokal API

Das Empfangen von Einträgen, Benutzern und Teams sollte imho auch ohne Api-Key möglich sein.

Das sind ja öffentliche Daten, die auch im Webinterface ohne Session sichtbar sind.

Alternativ könnte man anonymen Usern auch einen Api-Key mit eingeschränkten Rechten geben.
 

wildspitze

Aktives Mitglied
AW: Ankündigung: Winterpokal API

Das Empfangen von Einträgen, Benutzern und Teams sollte imho auch ohne Api-Key möglich sein.

Das sind ja öffentliche Daten, die auch im Webinterface ohne Session sichtbar sind.

Alternativ könnte man anonymen Usern auch einen Api-Key mit eingeschränkten Rechten geben.
Die Notwendigkeit des ApiKeys für alle Funktionen sehe ich nicht als Problem. Schließlich wollen die Betreiber ja sicher wissen, wer welche Api-Funktionen wie oft nutzt.

Sollte doch möglich sein, die entsprechenden Infos von einer zentralen Stelle (Server) mit einem deiner Keys abzurufen und dann in der App zur Verfügung zu stellen, oder?
 
Oben