Login, signup and forgot password API¶
Authentication: login, signup, forgot password, verification code, etc.
login page¶
- interface address:
/login
- HTTP request method:
GET
- request params:
- response code:
200: login page HTML
login¶
- interface address:
/login
- HTTP request method:
POST
- request params:
See the implementation: usually form fields such as email and password
- response code:
200: on success a session is written and the response redirects/returns; on failure an error message is returned
admin login¶
- interface address:
/adminlogin
- HTTP request method:
POST
- request params:
Same as login (administrator account)
- response code:
200: on success an administrator session is written
signup page¶
- interface address:
/signup
/signupemail
- HTTP request method:
GET
- request params:
admin (query, optional): true means the administrator signup entry
- response code:
200: signup page HTML
signup¶
- interface address:
/signup
/adminsignup
/normalsignup
- HTTP request method:
POST
- request params:
See the implementation: usually includes email, password, name, backupemail, admin, company, code (verification code), geetest_challenge/validate/seccode, etc.
- response code:
200: success or error message
get mail verify code¶
- interface address:
/getmailcode
- HTTP request method:
POST
- request params:
See the implementation: email, etc.
- response code:
200: result of sending the verification code
forgot password page¶
- interface address:
/forgotpassword
- HTTP request method:
GET
- request params:
- response code:
200: forgot password page HTML
get personal forgot password mail code¶
- interface address:
/forgotpassword/personal
- HTTP request method:
POST
- request params:
See the implementation: email, etc.
- response code:
200: send the password reset email/verification code
get ent admin forgot password mail code¶
- interface address:
/forgotpassword/entadmin
- HTTP request method:
POST
- request params:
See the implementation
- response code:
200: send the enterprise administrator password reset email
reset personal password¶
- interface address:
/resetpassword/personal
- HTTP request method:
POST
- request params:
See the implementation: verification code, new password, etc.
- response code:
200: reset result
reset ent admin password¶
- interface address:
/resetpassword/entadmin
- HTTP request method:
POST
- request params:
See the implementation
- response code:
200: reset result
logout¶
- interface address:
/logout
- HTTP request method:
POST
- request params:
- response code:
200: clear the session and redirect/return
change password (API)¶
- interface address:
/api/changepassword
- HTTP request method:
POST
- request params:
See the implementation (current password, new password, etc.)
- response code:
common response
Note: for changing the password of a logged-in user, see change password (api) in User and settings API.
geetest preprocess (captcha)¶
- interface address:
/gt_preprocess
- HTTP request method:
GET
- request params:
- response code:
200: Geetest preprocessing/challenge data
Note: human verification preprocessing for scenarios such as signup.
