Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎3 - Profile Store‎ > ‎

Login

Will attempt a login against the profile store.  With the request, the publisher can limit the number of failed attempts before an account is treated as locked out.  The response object will contain the userKey.  It is recommended to create a form ticket based on the userKey as most commerce and consumer functions required this.

Method: POST /api/v3/publisher/profilestore/login

Authentication: oauth
 
Post
Required Form Name Data Type Explanation
Yes
username string The username of the login attempt.  Can be the email address.
Yes
password
string The password of the logic attempt.
No
MaxFailedLoginAttempts int The profile store keeps track of failed login attempts.  If the publisher wishes to set this value, the response will return false if the failed login exceeds the count.

Returns
base response fields
userKey - When the logic was successful, the userkey of the logged in user.


Sample Request:

POST http://api.groupcommerce.com/api/v3/publisher/profilestore/login

Form: Username=username1&Password=password1&MaxFailedLoginAttempts=5

Authorization: OAuth oauth_signature="42ipkD9t%2fMEYAbiSHjIYHKWOi98%3d", oauth_nonce="8663643", oauth_timestamp="1320701525", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"


Sample JSON Response:

{
    "errors":[],
    "lastPublished":"/Date(1320701525208)/",
    "success":true,
    "version":"3",
    "userKey":"UserKey1"
}


Sample XML Response:

<loginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-11-07T21:32:45.4675544Z</lastPublished>
    <success>true</success>
    <version>3</version>
    <userKey>UserKey1</userKey>
</loginResponse>
Comments