Beachte: Die Hilfe-Seiten durchlaufen gerade eine vollständige Überarbeitung.

Proxer API/v1/User

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
Beschreibung Mit dieser Schnittstelle kann ein User mithilfe eines Passwortes und eines Usernamen eingeloggt werden
Link https://proxer.me/api/v1/user/login
Level Level 0
Eingabe Parameter (POST):
  • username (pflicht): Der Benutzername des zu einloggenden Benutzers.
  • password (pflicht): Das Passwort des zu einloggenden Benutzers.
  • secretkey (optional): Der Geheimschlüssel für die Zwei-Faktor-Authentifizierung. Nur nötig, wenn der User 2FA aktiviert hat.
Ausgabe
  • 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
  • 3038: Der User hat 2FA aktiviert, ein secretkey wird benötigt
  • 3039: Der angefragte Account ist abgelaufen
  • 3040: Der angefragte Account ist gesperrt
  • 3041: Ein internen Fehler ist aufgetreten
Logout
Beschreibung Mit dieser Schnittstelle kann ein User ausgeloggt werden
Link https://proxer.me/api/v1/user/logout
Level Level 0
Eingabe
  • Keine
  • Ausgabe
    • error: 0 oder 1. 0 wenn das Ausloggen erfolgreich war, 1 andernfalls
    • message: Eine Beschreibung des "error" Standes in Klartext
    Codes
  • Keine
  • Userinfo
    Beschreibung Mit 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.
    Link https://proxer.me/api/v1/user/userinfo
    Level Level 0
    Eingabe Parameter (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
    Ausgabe
    • 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
    Beschreibung Mit 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).
    Link https://proxer.me/api/v1/user/topten
    Level Level 0
    Eingabe Parameter (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.
    • isH (optional): Ob die Ausgabe Hentai Material enthalten darf. "true" um normale und H-Inhalte auszugeben, sonst "false" (Default, Hentai Inhalte werden gefiltert)
    Ausgabe
    • 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
    Beschreibung Mit 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).
    Link https://proxer.me/api/v1/user/list
    Level Level 0
    Eingabe Parameter (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.
    • isH (optional): Ob die Ausgabe Hentai Material enthalten darf. "true" um normale und H-Inhalte auszugeben, sonst "false" (Default, Hentai Inhalte werden gefiltert)
    • 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
    • filter (optional): Ermöglicht die Verwendung bestimmter vordefinierter Filter, erlaubte Eingaben (Fehlerhafte Eingaben resultieren in keiner Filterung)
      • stateFilterX: Ersetze X durch eine Zahl von 0 bis 3 (0

        geschaut, 1 = am schauen, 2 = wird geschaut, 3

        abgebrochen)
    Ausgabe
    • 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
    Beschreibung Mit 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).
    Link https://proxer.me/api/v1/user/comments
    Level Level 0
    Eingabe Parameter (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: Beides.
    • 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.
    Ausgabe
    • 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
      • name: Der Name des Entrys
      • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
      • kat: Die Kategorie des Entrys (anime oder manga)
      • 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
    Get History
    Beschreibung Mit dieser Schnittstelle kann die Chronik jedes Users per ID oder Username abgefragt werden. Dabei hat die ID Vorrang vor dem Username (ist also die ID eine gültige ID, wird der Username ignoriert). 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).
    Link https://proxer.me/api/v1/user/history
    Level Level 0
    Eingabe Parameter (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
    • 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.
    Ausgabe
    • 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 History Eintrags.
      • eid: Die ID des Entrys
      • name: Der Name des Entrys
      • language: Die Sprache, in der der Entry angesehen/gelesen wurde
      • episode: Die Episode/das Kapitel des Entrys, das angesehen/gelesen wurde
      • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
      • kat: Die Kategorie des Entrys (anime oder manga)
    Codes
    • 3003: User existiert nicht
    • 3014: Der Zugriff auf die gesuchte Information wurde verweigert
    Get About
    Beschreibung Mit dieser Schnittstelle kann die About-Seite jedes Users per ID oder Username abgefragt werden. Dabei hat die ID Vorrang vor dem Username (ist also die ID eine gültige ID, wird der Username ignoriert). 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).
    Link https://proxer.me/api/v1/user/about
    Level Level 0
    Eingabe Parameter (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
    Ausgabe
    • 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. Hierbei ist zu beachten, dass die Werte der Felder von dem jeweiligen User ausgefüllt werden, ohne dass Proxer großartig prüft, was in den Feldern steht. Deswegen ist nicht immer klar, wie der Inhalt eines Feldes formatiert ist. Jedes der Felder kann leer sein. (Objekt)
      • info_website: Der Wert des Feldes "Website". Könnte ein Link zu einer Website sein, vielleicht aber auch nur der Name.
      • info_occupation: Der Wert des Feldes "Beruf". Ein String ohne nähere Formatierung.
      • info_interests: Der Wert des Feldes "Interessen". Ein String ohne nähere Formatierung.
      • info_city: Der Wert des Feldes "Stadt". Ein String ohne nähere Formatierung.
      • info_country: Der Wert des Feldes "Land". Ein String ohne nähere Formatierung.
      • info_about: Der Wert des Feldes "About". Kann HTML-Tags beinhalten.
      • info_facebook: Der Wert des Feldes "Facebook". Könnte ein Link sein, oder einfach nur ein Name.
      • info_youtube: Der Wert des Feldes "Youtube". Könnte der Code eines Channels sein (youtube.com/channel/x), oder einfach nur ein Name.
      • info_chatango: Der Wert des Feldes "Chatango". Könnte ein Link sein, oder einfach nur ein Name.
      • info_twitter: Der Wert des Feldes "Twitter". Könnte ein Link sein, oder einfach nur ein Name.
      • info_skype: Der Wert des Feldes "Skype". Könnte ein Link sein, oder einfach nur ein Name.
      • info_deviantart: Der Wert des Feldes "Deviantart". Könnte ein Link sein, oder einfach nur ein Name.
      • info_birthday: Der Wert des Feldes "Geburtstag". Format: yyyy-mm-dd. Kann 0000-00-00 sein.
      • info_gender: Der Wert des Feldes "Geschlecht". Kann folgende Werte haben: leer, "f" (weiblich), "m" (männlich), "o" (sonstiges)
      • info_relationshipstatus: Der Wert des Feldes "Beziehungsstatus". Kann folgende Werte haben: leer, "single", "in_relation", "engaged", "complicated", "married", "searching", "not-searching"
    Codes
    • 3003: User existiert nicht
    • 3014: Der Zugriff auf die gesuchte Information wurde verweigert
    Request Authentification
    Beschreibung Mit dieser Schnittstelle, kann man eine Anfrage auf einen Login für einen spezifizierten User stellen. Durch Verwendung dieser Schnittstelle erhält der User eine Benachrichtigung. Alternativ zu dieser Schnittstelle, kann man den User auch auf einen Link verweisen, der das Format hat: proxer.me/auth?code=_code_&name=_name_ (bei Verwendung der Link-Methode wird keine Benachrichtigung generiert) Das bietet die Möglichkeit, die Notwendigkeit zu Tippen auf Tipp-unfreundlichen Geräten zu minimieren: Der User muss nur seinen Username in die App eintippen, und kann die Benachrichtigung auf einem anderen Gerät ansehen (und sich auf diesem Gerät einloggen). Bei Verwendung des Links muss der Anmeldevorgang auf dem selben Gerät stattfinden (dafür erfordert der Link weniger Zwischenschritte für den User)
    Link https://proxer.me/api/v1/user/requestauth
    Level Level 0
    Eingabe Parameter (GET oder POST):
    • uid (pflicht, nicht gleichzeitig mit username): User-ID, für den die Anfrage ist.
    • username (pflicht, nicht gleichzeitig mit uid): Username, für den die Anfrage ist.
    • code (pflicht): Ein beliebiger String, mit dessen Hilfe die Authentifizierung geprüft wird. Muss 100 Zeichen lang sein. Jeder Code kann für jeden User nur einmal verwendet werden.
    • name (pflicht): Der Name der aufrufenden App. Wird dem User direkt angezeigt, sollte also eindeutig sein.
    Ausgabe
    • 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.
    Codes
    • 3047: User existiert nicht
    • 3048: Der Code ist nicht 100 Zeichen lang
    • 3049: Der Code existiert bereits
    • 3053: Der Name darf nicht leer sein
    Check Authentification
    Beschreibung Mit dieser Schnittstelle, kann man prüfen, ob ein User einen per Request Authentification gesendeten Code bestätigt hat. Wenn ja, gibt die Schnittstelle ein gültiges Login-Token aus. Diese Schnittstelle muss innerhalb von 30 Minuten nach Anfrage des Codes verwendet werden, außerdem kann jeder Code nur einmal verwendet werden.
    Link https://proxer.me/api/v1/user/checkauth
    Level Level 0
    Eingabe Parameter (GET oder POST):
    • code (pflicht): Der selbe Code, der bei Request Authentification verwendet wurde.
    • name (pflicht): Der selbe Name, der bei Request Authentification verwendet wurde.
    Ausgabe
    • 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. (Objekt)
      • uid: Die ID des Users.
      • username: Der Username des Users.
      • avatar: Der Avatar des Users.
      • token: Ein gültiges Login-Token für den User.
    Codes
    • 3050: Die Kombination aus Code und Name wurde nicht bei Request Authentification verwendet, oder das Zeitlimit von 30 Minuten wurde überschritten.
    • 3051: Die Anfrage wurde vom User abgelehnt.
    • 3052: Die Anfrage wurde vom User noch nicht beantwortet.
    • 3054: Der Code wurde bereits verwendet.
    Kategorie:Proxer API