Proxer API/v1/User

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

Diese Klasse beinhaltet die grundlegenden Schnittstellen zur Verwaltung von Userdaten, vornehmlich Login und Logout, aber auch die Möglichkeit, einen neuen User zu registrieren sowie die öffentlichen Daten eines jeden Users per ID oder Username abzufragen.


Login

FunktionsnameLogin
BeschreibungMit dieser Schnittstelle kann ein User mithilfe eines Passwortes und eines Usernamen eingeloggt werden
Anfragelinkhttps://proxer.me/api/v1/user/login
ZugriffslevelLevel 0
EingabeparameterParameter (POST):
  • username (pflicht): Der Benutzername des zu einloggenden Benutzers.
  • password (pflicht): Das Passwort des zu einloggenden Benutzers.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war.
    • uid: Die ID des eingeloggten Users.
    • avatar: Der Avatar des eingeloggten Users.
    • token: Ein Login-Token. Möchte man das gewöhnliche Cookie-basierte Login System nicht verwenden, so kann man stattdessen bei jeder Anfrage die einen Login erfordert dieses Token senden.
Codes
  • 3000: Fehlende Login-Daten
  • 3001: Ungültige Login-Daten
  • 3012: Der User ist bereits eingeloggt
  • 3013: Ein anderer User ist bereits eingeloggt



Logout

FunktionsnameLogout
BeschreibungMit dieser Schnittstelle kann ein User ausgeloggt werden
Anfragelinkhttps://proxer.me/api/v1/user/logout
ZugriffslevelLevel 0
Eingabeparameter
  • Keine
Ausgabeparameter
  • error: 0 oder 1. 0 wenn das Ausloggen erfolgreich war, 1 andernfalls
  • message: Eine Beschreibung des "error" Standes in Klartext
Codes
  • Keine



Userinfo

FunktionsnameUserinfo
BeschreibungMit dieser Schnittstelle können die öffentlichen Daten jedes Users per ID oder Username abgefragt werden. Sind ID und Username gegeben, so wird ausschließlich die ID verwendet. Ist weder ID noch Username gegeben, so werden die Daten des eingeloggten Users abgerufen. Ist auch dies nicht gegeben, so wird eine Fehlermeldung ausgegeben.
Anfragelinkhttps://proxer.me/api/v1/user/userinfo
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • uid (optional, nicht gleichzeitig mit username): User-ID, deren Daten abgefragt werden sollen
  • username (optional, nicht gleichzeitig mit uid): Username, dessen Daten abgefragt werden sollen
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war.
    • uid: Die ID des abgefragten Users
    • username: Der Username des abgefragten Users
    • avatar: Der Avatar des abgefragten Users
    • status: Der momentane Status des abgefragten Users
    • status_time: Der Zeitpunkt der letzten Änderung des Status des abgefragten Users (Als Unix-Timestamp in Sekunden, false wenn nicht gesetzt)
    • points_uploads: Die Uploadpunkte des abgefragten Users
    • points_anime: Die Animepunkte des abgefragten Users
    • points_manga: Die Mangapunkte des abgefragten Users
    • points_info: Die Infopunkte des abgefragten Users
    • points_forum: Die Forums-Punkte des abgefragten Users
    • points_misc: Die sonstigen Punkte des abgefragten Users
Codes
  • 3003: User existiert nicht



Get Topten

FunktionsnameGet Topten
BeschreibungMit dieser Schnittstelle können die Topten jedes Users per ID oder Username abgefragt werden. Sind ID und Username gegeben, so wird ausschließlich die ID verwendet. Ist weder ID noch Username gegeben, so wird eine Fehlermeldung ausgegeben. Diese Schnittstelle respektiert die Sichtbarkeitseinstellungen der User. Hat ein User etwa die Sichtbarkeit nur "Für Freunde", so wird geprüft ob der momentan eingeloggte Nutzer mit dem User Befreundet ist. Es ist daher ratsam, vor der Verwendung dieser Schnittstelle einen User einzuloggen (oder ein token zu verwenden).
Anfragelinkhttps://proxer.me/api/v1/user/topten
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • uid (optional, nicht gleichzeitig mit username): User-ID, deren Daten abgefragt werden sollen
  • username (optional, nicht gleichzeitig mit uid): Username, dessen Daten abgefragt werden sollen
  • kat(optional): Die Kategorie, die geladen werden soll. Mögliche Werte: anime, manga. Default: anime.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war. (Array von Objekten)
    • eid: Die ID des Entrys
    • name: Der Name des Entrys
    • kat: Die Kategorie des Entrys (anime oder manga)
    • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
Codes
  • 3003: User existiert nicht
  • 3005: Die Kategorie existiert nicht
  • 3014: Der Zugriff auf die gesuchte Information wurde verweigert



Get List

FunktionsnameGet List
BeschreibungMit dieser Schnittstelle können die Entrylisten jedes Users per ID oder Username abgefragt werden. Sind ID und Username gegeben, so wird ausschließlich die ID verwendet. Ist weder ID noch Username gegeben, so wird eine Fehlermeldung ausgegeben. Diese Schnittstelle respektiert die Sichtbarkeitseinstellungen der User. Hat ein User etwa die Sichtbarkeit nur "Für Freunde", so wird geprüft ob der momentan eingeloggte Nutzer mit dem User Befreundet ist. Es ist daher ratsam, vor der Verwendung dieser Schnittstelle einen User einzuloggen (oder ein token zu verwenden).
Anfragelinkhttps://proxer.me/api/v1/user/list
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • uid (optional, nicht gleichzeitig mit username): User-ID, deren Daten abgefragt werden sollen
  • username (optional, nicht gleichzeitig mit uid): Username, dessen Daten abgefragt werden sollen
  • kat(optional): Die Kategorie, die geladen werden soll. Mögliche Werte: anime, manga. Default: anime.
  • p (optional): Dieser Parameter gibt an, welche Seite geladen werden soll. Default Wert 0. Start bei 0.
  • limit (optional): Dieser Parameter gibt an, wie viele Einträge eine Seite enthalten soll. Default Wert 100.
  • search (optional): Durch die Angabe dieses Parameters werden nur Entrys angezeigt, die den angegeben Wert als Substring ihres Namens haben. Dabei ist die Position im Namen egal.
  • search_start (optional): Durch die Angabe dieses Parameters werden nur Entrys angezeigt, die den angegeben Wert als Substring zu Beginn ihres Namens haben.
  • sort (optional): Dieser Parameter gibt an, wie die Liste sortiert werden soll, erlaubte Eingaben (Fehlerhafte Eingaben werden auf den Default-Wert gezwungen):
    • nameASC: Sortierung nach Entry-Name Aufsteigend
    • nameDESC: Sortierung nach Entry-Name Absteigend
    • stateNameASC: Sortierung nach Status des Entrys, dann Entry-Name Aufsteigend (default Wert)
    • stateNameDESC: Sortierung nach Status des Entrys, dann Entry-Name Absteigend
    • changeDateASC: Sortierung nach letzter Änderung Aufsteigend
    • changeDateDESC: Sortierung nach letzter Änderung Absteigend
    • stateChangeDateASC: Sortierung nach Status des Entrys, dann letzter Änderung Aufsteigend
    • stateChangeDateDESC: Sortierung nach Status des Entrys, dann letzter Änderung Absteigend
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war. (Array von Objekten)
    • id: Die ID des Entrys
    • name: Der Name des Entrys
    • count: Anzahl der Folgen/Kapitel (müssen nicht hochgeladen sein!)
    • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
    • estate: Der Status des Entrys
    • cid: Die ID des zugehörigen Kommentars
    • comment: Der Text des zugehörigen Kommentars
    • state: Der Status des zugehörigen Kommentars
    • episode: Die Episodenzahl des zugehörigen Kommentars (bis wohin der Entry gesehen/gelesen wurde)
    • data: Die Daten des zugehörigen Kommentars
    • rating: Die Bewertung des Entrys durch den User (0 bis 10)
    • timestamp: Der Änderungszeitpunkt des Kommentars (Unix-Timestamp als Integer)
Codes
  • 3003: User existiert nicht
  • 3005: Die Kategorie existiert nicht
  • 3014: Der Zugriff auf die gesuchte Information wurde verweigert



Get Latest Comments

FunktionsnameGet Latest Comments
BeschreibungMit dieser Schnittstelle können die letzten Kommentare jedes Users per ID oder Username abgefragt werden. Sind ID und Username gegeben, so wird ausschließlich die ID verwendet. Ist weder ID noch Username gegeben, so wird eine Fehlermeldung ausgegeben. Diese Schnittstelle respektiert die Sichtbarkeitseinstellungen der User. Hat ein User etwa die Sichtbarkeit nur "Für Freunde", so wird geprüft ob der momentan eingeloggte Nutzer mit dem User Befreundet ist. Es ist daher ratsam, vor der Verwendung dieser Schnittstelle einen User einzuloggen (oder ein token zu verwenden).
Anfragelinkhttps://proxer.me/api/v1/user/comments
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • uid (optional, nicht gleichzeitig mit username): User-ID, deren Daten abgefragt werden sollen
  • username (optional, nicht gleichzeitig mit uid): Username, dessen Daten abgefragt werden sollen
  • kat(optional): Die Kategorie, die geladen werden soll. Mögliche Werte: anime, manga. Default: anime.
  • p (optional): Dieser Parameter gibt an, welche Seite geladen werden soll. Default Wert 0. Start bei 0.
  • limit (optional): Dieser Parameter gibt an, wie viele Einträge eine Seite enthalten soll. Default Wert 25.
  • length (optional): Dieser Parameter gibt die minimale Anzahl an Zeichen an, ab der ein Kommentar angezeigt werden soll. Default 300.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war. (Array von Objekten)
    • id: Die ID des Kommentars
    • tid: Die ID des Entrys
    • state: Der beim Kommentar angegebene Status (0 = geschaut, 1 = am schauen, 2 = wird geschaut, 3 = abgebrochen)
    • data: Zusätzliche informationen, die als json-String abgespeichert werden. Es kann sich hierbei beispielsweise um die "Genre"-Bewertung handeln.
    • comment: Der Kommentar-Text
    • rating: Die Bewertung des Entrys
    • episode: Die Episode, bis zu der der Kommentarschreiber geschaut hat
    • positive: Wie viele Personen den Kommentar hilfreich finden.
    • timestamp: Der Zeitpunkt der Erstellung des Kommentars (Unix-Timestamp in Sekunden)
    • username: Der Username des Erstellers des Kommentars
    • uid: Die User-ID des Erstellers des Kommentars
    • avatar: Das Profilbild des Erstellers des Kommentars
Codes
  • 3003: User existiert nicht
  • 3005: Die Kategorie existiert nicht
  • 3014: Der Zugriff auf die gesuchte Information wurde verweigert