vB5 Manual and API Documentation
Forums API Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Login/Logout Process

This article explains the process of user login and logout with API.

Login Process

The client is able to login user with user.login2 method.

If login successfully, It will return a new sessionhash, the userid. Here’s an example:


Otherwise it will throw ‘badlogin’ error.

Note that after user login, the sessionhash and apiaccesstoken will be regenerated. So the Authorization header won’t be returned to the client in this method.

Because of technical limit, this method is unable to return a new securitytoken. So after this API call user.login2, client should call api.init to get the new securitytoken. Once the client gains both the new sessionhash and the securitytoken, please save them in application session vars. And then login process is done. You need to pass the new sessionhash to the API and use the new securitytoken to sign the requests in future API method calls.

Logout Process

Client should call user.logout to logout an user. And it will return a new session hash just the same as user.login2.

Client don’t need to fetch a new apiaccesstoken again because after logging out, the new security token is always be ‘guest’. But if client needs other refreshed variables, call api.init.