API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.login

Verifies the given username and password, associates the user with the current HTTP session and returns the result.
Category: Login functions
Subcategory:
Description: Used to get the current HTTP session ID generated by the web container.

You may want to use this method if your programming language or application is not able to use, query or track HTTP cookies.

Parameters

Only mandatory parameters must be present for an API call on this function. Parameters marked as a list can occur multiple times in both SOAP and HTTP-RPC style requests.
Name Type Mandatory is List Description
username string required The username or email address of the user to log in.
password string required The password of the user to log in.
remember boolean Remember login.

Return Values

The presence of return values depend on the meaning of the API function and status of the requested object. For example, the description value of a looop will not be returned, if it has not been set.
Name Type is List Description
httpSessionID string The current HTTP session ID
success boolean true, if the login succeeded
userID uuid ID of the imagelooop user
username string name of the imagelooop user
userpage string user page permalink

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
1000 imagelooop.LoginWrongAuthDataException
1001 imagelooop.LoginLockedAccountException
1002 imagelooop.LoginUnconfirmedEmailException
2000 imagelooop.TooManySecurityMethodCallsException
2005 imagelooop.InternalErrorException

API Call examples

HTTP-RPC

Request:
The line breaks and white spaces are for better reading only. All request parameters can be passed in the HTTP POST request body instead of a HTTP GET parameter in a URL. Valid HTTP POST content types are multipart/form-data for file uploads and application/x-www-form-urlencoded for usual HTML forms.

http://www.imageloop.com/httprpc/?apiKey=YOUR-API-KEY
    &f=imagelooop.login
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &username=string-value
    &password=string-value
    &remember= (optional)



Sample response

Sample Response to illustrate what's returned (XML schema) :
The line breaks and white spaces are for better reading only.

<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <response name="httpSessionID">
      <value>string-value</value>
   </response>
   <response name="success">
      <value>boolean-value</value>
   </response>
   <response name="userID">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="username">
      <value>string-value</value>
   </response>
   <response name="userpage">
      <value>string-value</value>
   </response>
</imag:Response>
If the function call resulted in an error, no response element but an error element is returned in the above XML. See list of possible errors/exception for the function described on this page.
<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <error>
      <errorCode>error-code</errorCode>
      <errorType>error-name</errorType>
      <message>optional error message</message>
   </error>
</imag:Response>

SOAP

General overview including SOAP and XML schema types is available here. See http://www.imageloop.com/soap/api/api.wsdl for WSDL definition. http://www.imageloop.com/soap/api/api.xsd for XSD definition.