API

Zugriffe auf die JSON-API: Hilfestellung (Working Draft)

API

Die JSON API ist der beste Weg, um mit dem Emotionum zu kooperieren.

Die API ist in einer limitierten Version frei verfügbar und kann mit einem API-Schlüssel auf einen Vollzugriff erweitert werden.

  1. Limitierte öffentliche Version
    Hier können alle öffentlichen anfragen gestellt werden, die auf lesende Anfragen beschränkt sind.
    Ideal für Zugriffe auf den Profifußball von Partnern ohne eigenes User und Spielermanagement.
  2. Premium Version (API-Key erforderlich)
    Mit der Premium-Version können lesende und schreibende Aufrufe sowie Private-Ansichten ausgeführt werden.
    Neue Spieler können in eigenen Netzwerken angelegt und über SSO kann eine verhandene User-Verwaltung verknüpft werden. 
    Ideal für eigene Produkte/Intranets oder APPs.
    API-Schlüssel anfragen.

Konzeption

Netzwerke

Netzwerke spielen in der Kooperation mit dem Emotionum eine besondere Rolle, denn sie ermöglichen eine Verknüpfung von Spielern und Usern in einem einheitlichen Umfeld.

Lediglich hier lassen sich für den kooperationspartner neue Spieler erstellen und Zugriffsrechte dezidiert verwalten. Netzwerke können unterschiedliche Restriktionen besitzen:

  1. Öffentlich / Offen
    Beispiel: Bundesliga Mannschaften
    • Alle User und Spieler sind öffentlich zugänglich.
    • Jeder kann diesem Netzwerk beitreten.
    • Das Netzwerk ist öffentlich einsehbar, kann gesucht und gefunden werden.
    • Jeder Spieler ist öffentlich einsehbar und kann gesucht und gefunden werden.
  2. Öffentlich / Geschlossen
    Usecase: Öffentliche Spielerauswah, die vertraulich eingeschätzt werden soll.
    • Das Netzwerk ist öffentlich, taucht in öffentlichen Listen auf.
    • User müssen Mitglieder des Netzwerk sein, um die Inhalte zu sehen.
    • Spieler des Netzwerkes können überall gesehen werden, wenn diese öffentlich sind. 
    • Freunde innerhalb des Netzwerkes können ihre einzelnen Einschätzungen sehen.
    • Einschätzungen können explizit für dieses Netzwerk abgegeben werden.
  3. Privat / Offen
    Usecase: Netzwerk, dessen Adresse bekannt sein muss, um es zu sehen.
    • Das Netzwerk taucht nicht öffentlich auf.
    • Jeder kann dem Netzwerk beitreten.
    • User müssen Mitglieder des Netzwerk sein, um die Inhalte zu sehen.
  4. Privat / Geschlossen
    Usecase: Vertrauliche User/Spieler Gemeinschaften, z.B. Jugendmannschaften
    • Das Netzwerk taucht nicht öffentlich auf.
    • User müssen Mitglieder des Netzwerk sein, um die Inhalte zu sehen.
    • Freunde innerhalb des Netzwerkes können ihre einzelnen Einschätzungen sehen.
    • Einschätzungen können explizit für dieses Netzwerk abgegeben werden

Zugriffe

  1. Öffentliche API
    • Alle öffentlichen Listen, Netzwerke, User und Spieler
    • Keine userspezifischen Anfragen (/my/), da kein Login möglich.
    • Alle Serviceleistungen: Gerenderte Emotiona, Vorschaubilder, Formulare 
  2. Partner API
    • Siehe 1.
    • Backend/Middleware Session-Sharing
    • Userspezifische Zugriffe (/my/)
    • Login/Logout
    • SSO

Services

  1. Generische Vorschaubilder 
    Usecase: Private Profile (Ohne Preview-Funktion)
    https://api.emotionum.com/_partner/preview.svg.php?help
    https://api.emotionum.com/_partner/preview.svg.php?color=258&logo=1&values=22,55,88,44,66&id=95
  2. Who Am I
    Usecase Spielervergleich
    Formular: https://api.emotionum.com/_partner/whoami.php
    URL: https://test-football.emotionum.com/de/e/object/similar?values=[values]&framed=0&class=1&myname=ccc&myposition=goal
    Spielervergleich
    URL: https://api.emotionum.com/_partner/compare.php?color=5d5e5a&compare=1051,1242&format=svg
    URL:https://api.emotionum.com/_partner/compare.php?color=5d5e5a&compare=1051,1242&format=svg&mycompare=[values]

Version

Freitag, 10. März 2017