Sign Up User

From Creately Developer

Jump to: navigation, search

Contents

Description

This method is used to create a new user account in Creately. Only a API Key holder can access this method. When a valid user account is created, the account will be attached to the API Key as a reference. The API Key will have access on the user account and its data. The username for a new user account must be in the format of an email address ie. example@example.com

Request

Request Details

URL https://creately.com/api/auth/signup
HTTP Method POST
Supported Authentication SA
API Permissions This API call will not require any permissions
User Permissions Not applicable

Request Parameters

Parameter Description Required Default Value
usr Must be a valid email address. This will be used as the user name of the potential Creately account Mandatory N/A
pwd The plain text password that will be used as the account password Mandatory N/A
firstname The first name of the user Mandatory N/A
surname The last name of the user Mandatory N/A
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 The newly created account Creately User ID will be returned on successful response.

Response Parameters

Tag Description
success Indicates if the request was successfully processed. May have true or false
uid The unique ID of the newly created Creately user account.
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 Sign Up User method are: 1014


Examples

Example 1

Request

https://creately.com/api/auth/signup?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&pwd=securepassword&firstname=John&surname=Doe

Response

	<creately-api-response>
 		<success>true</success>
 		<uid>0d4fece0-0a10-4050-94e3-155270faceca</uid>
 	</creately-api-response>
Personal tools