API-Zugriff auf Chat-Datenbank / Anbindung an Drittsysteme

Hier wird über wichtige Neuerungen informiert.
Antworten
Webkicks
Webkicks - Team
Beiträge: 752
Registriert: 02.05.2003, 00:16
Kontaktdaten:

API-Zugriff auf Chat-Datenbank / Anbindung an Drittsysteme

Ungelesener Beitrag von Webkicks » 24.11.2015, 16:26

Hallo zusammen,

in der Vergangenheit kam häufiger der Wunsch auf, die Chat-Datenbank mit eigenen Datenbanken (z.B. dem eigenen Forum) zu verbinden, damit sich Nutzer nicht mehrfach für verschiedene Dienste derselben Website registrieren müssen. Aus diversen technischen Gründen sind Direktzugriffe auf die Chatdatenbank grundsätzlich nicht möglich. Dennoch möchten wir künftig gerne eine gewisse Basis-Funktionalität bereitstellen, mit der sich die Chat-Datenbank an andere Systeme andocken lässt. Hierzu stellen wir zum Start die folgenden API-Methoden zur Verfügung:

chatter_create

Aufruf: https://serverX.webkicks.de/chatname/api/username/password/chatter_create?nickname=NUTZER&password=PASSWORT&email=EMAIL&bady=TT-MM-JJJJ

Die Abschnitte serverX, chatname, username und password müssen durch gültige Admin-Nutzerdaten ersetzt werden. Die Abschnitte NUTZER, PASSWORT, EMAIL und BDAY sind durch die Daten zu ersetzen, für die ein neuer Nutzeraccount im Chat angemeldet werden soll. Falls der Nutzer das 16. Lebensjahr noch nicht vollendet hat muss zusätzlich die E-Mail-Adresse der Eltern mit &parentmail=EMAIL-DER-ELTERN übergeben werden. Die Eltern werden dann zunächst per E-Mail um Zustimmung gebeten, bevor das Nutzerkonto aktiviert wird.

Funktion: Der Aufruf erzeugt einen neuen Nutzeraccount im Chat und sendet eine Freischaltmail an die per EMAIL definierte E-Mailadresse des Nutzers. Dieser Schritt kann aus rechtlichen Gründen leider nicht entfallen und es ist wichtig, dass hier wirklich die E-Mailadresse des neuen Nutzers angegeben wird und keine eigene. Andernfalls könnte der Nutzer die "Passwort vergessen"-Funktion nicht nutzen, würde keine Chat-Newsletter erhalten und im schlimmsten Fall würdet Ihr für rechtliche Verstöße des Nutzers zur Haftung gezogen. Bitte daher immer die korrekte E-Mailadresse des Nutzers übermitteln.

Zielsetzung: Die Funktion kann automatisiert aufgerufen werden, sobald sich ein Nutzer in einem anderen System (z.B. in einem Forum) registriert. Der Nutzer spart sich somit die zusätzliche Registrierung im Chat und erhält direkt die Freischaltmail.

Rechtliches: Der Nutzer muss vorab ausdrücklich darauf hingewiesen werden, dass er automatisch auch im Chat angemeldet wird. Bitte weist ihn entsprechend darauf hin und bietet ggf. auch eine Möglichkeit, die zusätzliche Anmeldung im Chat nicht durchzuführen.

chatter_delete

Aufruf: https://serverX.webkicks.de/chatname/api/username/password/chatter_delete?nickname=NUTZER

Die Abschnitte serverX, chatname, username und password müssen durch gültige Admin-Nutzerdaten ersetzt werden. NUTZER ist durch den Nutzernamen im Chat zu ersetzen, der gelöscht werden soll.

Funktion: Löscht den Nutzeraccount von NUTZER vollständig aus der Chat-Datenbank.

Zielsetzung: Hierüber kann erreicht werden, dass ein Nutzer automatisch auch aus der Chat-Datenbank gelöscht wird, wenn er die Löschung an anderer Stelle (z.B. in Eurem Forum) vornimmt. Ihr vermeidet auf diesem Weg, dass sich ein Nutzer zwar von Eurer Website löscht, der Account im Chat aber versehentlich bestehen bleibt. Auch hier sollte der Nutzer explizit darauf hingewiesen werden, dass eine Löschung im Chat erfolgt.

Der Aufruf der API-Funktionen wird im Erfolgsfall wie folgt bestätigt:

Code: Alles auswählen

{
   "message" : "ok",
   "statuscode" : 1
}
Fehlermeldungen sehen hingegen z.B. so aus:

Code: Alles auswählen

{
   "message" : "invalid nickname",
   "statuscode" : 201
}
Es sollte immer ein Fehler-Management implementiert werden, da sich nicht alle Fehler schon vorab ausschließen lassen. Beispielsweise würde die Registrierung scheitern, falls es den Nutzernamen schon gibt.

Hier eine Übersicht über alle Fehlercodes:
  • chatter_create
  • 101 Der Nutzername ist schon vergeben
  • 102 Der Nutzername wird derzeit von einem Gast genutzt
  • 103 Der Nutzername ist durch die Nicksperre gesperrt
  • 104 Der Nutzername hat mehr als 20 Zeichen
  • 105 Der Nutzername hat weniger als 2 Zeichen
  • 106 Der Nutzername ist systemseitig verboten (z.B. "Webkicks")
  • 107 Der Nutzername enthält verbotene Zeichen
  • 108 Das Passwort hat mehr als 30 Zeichen
  • 109 Das Passwort hat weniger als 6 Zeichen
  • 110 Das Passwort enthält verbotene Zeichen
  • 111 Die E-Mailadresse hat mehr als 100 Zeichen
  • 112 Die E-Mailadresse ist ungültig
  • 113 Es existiert bereits ein Nutzeraccount mit dieser E-Mailadresse
  • 114 Die E-Mailadresse ist gesperrt
  • 115 Das Geburtsdatum ist ungültig
  • 116 Die E-Mailadresse der Eltern hat mehr als 100 Zeichen
  • 117 Die E-Mailadresse der Eltern ist ungültig
  • chatter_delete
  • 201 Es wurde kein NICKNAME übergeben
  • 202 NICKNAME ist Mod oder Admin
Ich hoffe es finden sich sinnvolle Einsatzgebiete für den API-Zugriff auf die Chat-Datenbank. Feedback und zusätzliche Wünsche sind wie immer herzlich willkommen.

Viele Grüße
WK-Team

Benutzeravatar
Linus
Moderator
Beiträge: 1124
Registriert: 14.02.2005, 20:31
Wohnort: NRW
Kontaktdaten:

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von Linus » 24.11.2015, 16:37

Coole Idee! Vor allem dadurch, dass das Captcha hier wegfällt, hat das ganze Potential. Ein Anwendungsfall den ich ganz spontan sehe ist die automatisierte Anmeldung eines Bot-Nicks für den wkQB :mrgreen: Zwar ungünstig, dass ich dafür dann noch immer freischalten müsste (was man ja automatisieren kann, die Mail-Adresse würde automatisch generiert werden und auf meinem Server im Catchall landen, wo sich ein Script drüber hermachen könnte), aber ein sehr guter Anfang :)
Kein Support per PN!

keine
Beiträge: 72
Registriert: 09.05.2004, 20:13
Kontaktdaten:

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von keine » 12.12.2015, 18:39

Ich finde das sehr interessant, weil ich auch ein Forum für den Chat habe. Und einige User hatten auch schon gemeint sie wären automatisch bei beidem angemeldet, wenn sie sich nur im Chat oder nur im Forum registriert haben. Wäre sehr nützlich für mich.

Allerdings versteh ich hier leider nur Bahnhof. :?: Wo muss man denn das alles angeben? Im Forum oder im Chat? Und wo genau? Kann auch mit dem Begriff API Zugriff nichts anfangen. Kann mir das bitte jemand erklären, was ich da machen muss.

Wenn ich die Erklärung richtig verstanden habe, geht das auch nur in eine Richtung? Also von Forum zu Chat, umgekehrt aber nicht? Wenn sich jemand im Chat registriert, ist er also nicht im Forum automatisch angemeldet, umgehkehrt aber schon? hab ich das richtig verstanden.

masterronnow
Beiträge: 182
Registriert: 18.04.2006, 18:33
Wohnort: Berlin

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von masterronnow » 21.12.2015, 16:58

Du musst in dem Fall die reg.php (z.B.) anpassen und neue Felder einfügen, die bei der Registrierung ausgefüllt werden müssen.

Nette Änderung, probiere es gleich mal mit phpBB 3.1 aus.

masterronnow
Beiträge: 182
Registriert: 18.04.2006, 18:33
Wohnort: Berlin

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von masterronnow » 21.09.2016, 01:13

Eine Frage hätte ich hier:

wie ist es möglich die Variabeln im Link mit klick auf den Absenden Button im Registrierungsformular von phpBB3.1 mit den passenden Daten zu befüllen und gleichzeitig abzugleichen, ob ein Fehler auftritt und dann den Vorgang abzubrechen ohne das eine Registrierung im Forum erfolgte?

1. FC Keller
Moderator
Beiträge: 866
Registriert: 04.07.2004, 17:10
Wohnort: heimat:// Thüringen.Deutschland.eu/ Zeulenroda
Kontaktdaten:

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von 1. FC Keller » 11.10.2016, 14:17

Dafür wäre der Quellcode der entsprechenden reg.php (oder wie auch immer die Datei dort heißt) nützlich.

masterronnow
Beiträge: 182
Registriert: 18.04.2006, 18:33
Wohnort: Berlin

Re: API-Zugriff auf Chat-Datenbank / Anbindung an Drittsyste

Ungelesener Beitrag von masterronnow » 12.10.2016, 02:37

1. FC Keller hat geschrieben:Dafür wäre der Quellcode der entsprechenden reg.php (oder wie auch immer die Datei dort heißt) nützlich.
Siehe dazu:

individuelle-entwicklungen-anpassungen- ... 24549.html

Wollte hier den Thread damit dann doch nicht voll müllen. :)

Antworten

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast