User Services - Login

LOGIN [user] to Freewebs


 Endpoint URL http://api.webs.com/v1/user/login/[user]

HTTP Method POST

Parameters apikey=[partner key] (String)
password=[password] (String)
auth=[MD5 hash of authorization key, partner key, and user password] (String)

Usage Notes

Using the auth parameter is the preferred method of login, since this prevents user passwords being sent clear text. The auth parameter should be a MD5 hash that is simply the string "fr33w3bs" + your apikey + the user's password. We will continue to support the password parameter for now, but will eventually phase it out.

The token value in the response is the token value passed on subsequent API service invocations of any type. The token value identifies a user session.

Example Good Response

<?xml version="1.0" encoding="utf-8" ?>   
<rsp stat="ok">   
  <user name=”fred”>   
    <token>8dbb03893f96ab32110957f10ce</token>   
  </user>   
</rsp>

Error Codes (see response format in Technical Description)

Code Response
200 Username was not provided in URI
210 Received unknown request
220 Cannot find or create session for user with information provided
230 Encountered errors during user login
240 Does not support this HTTP method for this operation
260 Username [name] does not exist
270 Encountered errors during user existence check

version 4 as of 1 year ago by Brandon

Comments

Please sign in to post a comment.