Browser Login

From Creately Developer

Jump to: navigation, search

Contents

Description

This method is used to create a Temporary Redirect Token for authenticating a user to Creately Site. To further understand how this is done see Browser Authentication


Request

Request Details

URL https://creately.com/api/auth/browser
HTTP Method POST
Supported Authentication CT or SA
API Permissions This API call will not require any permissions
User Permissions The provided user account will need to be active

Request Parameters

Parameter Description Required Default Value
returnxml A boolean value indicating "true" or "false". Specifies if response should be a XML. Response will be sent in a XML if the value is true. Response will be sent in a serial string if the value is false. Optional true

NOTE: Parameters required by the authentication method must be provided. See what parameters are required in Authentication

Response

Response Details

Type XML
Content A valid TRT will be returned on successful response.

Response Parameters

Tag Description
success Indicates if the request was successfully processed. May have true or false
token A valid Temporary Redirect Token will be provided.
errorcode Will be available if the success parameter was false. Will contain a valid API Error code. Valid error codes are listed in API Error Codes
message Will be available if the success parameter was false. Will contain a string message for the error

Errors

Refer to Errors related to Auth API calls in the Error Codes
Possible errors for Browser Login method are: Any error on 1000 range


Examples

Example 1

Request

https://creately.com/api/auth/browser?apikey=2njk4234j23hkj23h4j2k3423jk4h&uid=0d4fece0-0a10-4050-94e3-155270faceca&sig=jkn435654jk2j1kjh3mjk9

Response

	<creately-api-response>
 		<success>true</success>
 		<token>jhb345kl74kbj7kjb24jknd9sdnsj4378dmlkadfd63bdd04m37xn02ndhgc6ixh6den39dhn3</token>
 	</creately-api-response>
Personal tools