Proxer API/Login

Aus Proxer.Me - Wiki
Wechseln zu: Navigation, Suche

Diese Schnittstelle ermöglicht das Einloggen auf Proxer über eine Anwendung. Außerdem eignet sich diese Schnittstelle auch zur Überprüfung einer aktiven Session.


Eingabe

https://proxer.me/login?format=json&action=login


POST-Parameter:

  • username (optional): Der Benutzername des zu einloggenden Benutzers.
  • password (optional): Das Passwort des zu einloggenden Benutzers.


Ausgabe

Die Ausgabe dieser Abfrage ist ein JSON-Objekt.

  • error: 0 oder 1. 0 wenn das Einloggen erfolgreich war oder eine aktive Session gefunden werden konnte. Ansonsten 1.
  • uid (optional): Im Falle eines erfolgreichen Einloggens ist hier die User-ID des eingeloggten Benutzers zu finden.
  • message (optional): Im Falle eines Fehlers wird hier eine Nachricht ausgegeben.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • avatar (optional): Im Falle eines erfolgreichen Einloggens wird hier der Dateiname des Avatar Bildes angezeigt.

Fehlercodes

  • 0: Sonstige Fehler (falsche Eingabeparameter/Firewall)
  • 1: Fehlende Zugangsdaten
  • 2: Falscher Benutzername/falsches Passwort


Beispiel

Will man überprüfen, ob ein Benutzer eingeloggt ist, reicht eine einfache GET Abfrage ohne Zugangsdaten. Soll zusätzlich automatisch eingeloggt werden, falls der Benutzer nicht eingeloggt ist, so müssen die POST-Parameter übergeben werden.


https://proxer.me/login?format=json&action=login


POST-Parameter:

  • username: Test
  • password: das-passwort-von-test


Verhalten

Beachte, dass eine Session auf Proxer genau 60 Minuten gültig ist. Findet in dieser Zeit keine Anfrage statt, so wird der Benutzer automatisch ausgeloggt, und man muss sich erneut einloggen. Falls innerhalb der 60 Minuten eine Anfrage stattfindet, so wird die Session erneuert.

Falls man eine Anfrage an eine andere Schnittstelle (z.B. Benachrichtigungen) stellt, wird dieser eine Fehlermeldung geben, falls der Benutzer keine aktive Session hat. In diesem Falle muss eine neue Anmeldung durchgeführt werden.