diff --git a/docu/login_server.api.md b/docu/login_server.api.md new file mode 100644 index 000000000..1342d8284 --- /dev/null +++ b/docu/login_server.api.md @@ -0,0 +1,77 @@ +# login server api + +Gradido js-Frontend vereinfachte Zusammenarbeit mit Login-Server und Community-Server + +Es ist mit einer Zusatz-Option möglich das Login und Registrieren via ajax-Request passiern kann. +Dafür muss in der Login-Server Config + +unsecure.allow_passwort_via_json_request = 1 + +gesetzt sein. + +In diesen Beispielen gehe ich jetzt davon aus, das du das gesamte Gradido Projekt mit Docker gebaut hast und auf dem lokalen Rechner laufen lässt. + +Login +Einloggen über: + + +# unsecureLogin + +POST http://localhost/login_api/unsecureLogin +``` +data: {"username": "", "password": ""} +``` + +Wenn alles okay ist erhältst du: +``` +{"state":"success", "session_id": , "clientIP":"", + "user": { + "created": , + "disabled": , // login will fail if user is disabled + "email": "", + "email_checked": , // true if user has already clicked on email verification code link in his emails + "first_name": "", + "group_alias": "", + "ident_hash": , + "last_name": "", + "public_hex": "<64 character hex (contain only a-f and 0-9)>", + "role": "", // should be only valid for login-server + "username": "", + "balance": , // 174500 = 17,45 GDD + "id": , + "errorCount": +}} +``` + +Anmelden +Registrieren kannst du einen neuen Benutzer mit: + + +## createUser + +POST http://localhost/login_api/createUser +``` +data: {"email":"", "first_name":"", "last_name":"" , + "emailType": 2, "password":""} +``` + +Wenn alles okay ist erhältst du: +``` +{"state":"success"} +``` + +Dann wurde für den Benutzer ein neues Konto angelegt, seine Schlüssel generiert und ihm eine Bestätigungs-Email geschickt. + + +## Logout + +Abmelden +POST http://localhost/login_api/logout +``` +data: {"session_id": } +``` + +Wenn alles okay ist erhältst du: +``` +{"state":"success"} +``` \ No newline at end of file