|
Version: 1
HCnix Build: 3.00 and later
API Build: 1.00 and later
User Manager - SignupUser creates a user with given details. This web service call can be made as http://your-domain.com/HCnixAPI/UserManager.php?op=SignupUser.
Input Parameters
HostUserName
HostPassword
OwnerName - User name under which you want to create new user.
PlanName - Plan name to be sold at user creation time.
NewUserName - Name of the user to be created.
NewUserPassword - Password of the user to be created.
EmailAddress - Email address of the user to be created.
OptionalParam
WebServerName - If sent, user will be created on specified server otherwise loadbalancing will be done.
ResellerType - possible values are General and Dedicated
IsSubdomain - True/False
WebsiteName - required for Webadmins for setting up the website
Language
Output Parameters
N/A
Sample Optional Parameters
<Parameters>
<Parameter Name = "WebServerName">abc</Parameter>
<Parameter Name = "ResellerType">Dedicated</Parameter>
<Parameter Name = "IsSubdomain">True</Parameter>
<Parameter Name = "WebsiteName">MyDomain.com</Parameter>
<Parameter Name = "Language">French</Parameter>
</Parameters>
Sample SOAP Request
|
POST /HCnixAPI/UserManager.php HTTP/1.1 Host: your-domain.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://tempuri.org/SignupUser" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SignupUser xmlns="http://tempuri.org/"> <HostUserName>host</HostUserName> <HostPassword>host123</HostPassword> <OwnerName>david</OwnerName> <PlanName>Basic Plan</PlanName> <NewUserName>john</NewUserName> <NewUserPassword>johnnew</NewUserPassword> <EmailAddress>john@hosting.net</EmailAddress> <OptionalParam>xml</OptionalParam> </SignupUser > </soap:Body> </soap:Envelope>
|
Sample HTTP Request
|
POST /HCnixAPI/UserManager.php/SignupUser HTTP/1.1 Host: your-domain.com Content-Type: application/x-www-form-urlencoded Content-Length: length HostUserName=host&HostPassword=host123&OwnerName=david&PlanName=BasicPlan& NewUserName=john&NewUserPassword=johnnew&EmailAddress=john@hosting.net&OptionalParam=xml
|
Sample PHP Code
|
function SignUpUser($strHostUserName, $strHostPassword, $strOwnerName, $strPlanName, $strNewUserName, $strNewUserPassword, $EmailAddress, $OptionalParam) { $response=""; $soapPacket = "<?xml version=\"1.0\" encoding=\"utf-8\"?> <soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\"> <soap:Body> <SignUpUser xmlns=\"http://tempuri.org/\"> <HostUserName>$strHostUserName</HostUserName> <HostPassword>$strHostPassword</HostPassword> <OwnerName>$strOwnerName</OwnerName> <PlanName>$strPlanName</PlanName> <NewUserName>$strNewUserName</NewUserName> <NewUserPassword>$strNewUserPassword</NewUserPassword> <EmailAddress>$strEmailAddress</EmailAddress> <OptionalParam>$OptionalParam</OptionalParam> </SignUpUser> </soap:Body> </soap:Envelope>"; // where $domain_name is where HCnix APIs are installed $fp = fsockopen($domain_name, 80, $errNo, $errString, 90); if($fp) { // where $name is the Virtual Directory name for HCnix APIs $header = "POST /$name/UserManager.php HTTP/1.1\r\n"; $header .= "HOST: $domain_name\n"; $header .= "Content-Type: text/xml;charset=\"utf-8\"\r\n"; $header .= "Content-Length: ".strlen($soapPacket)."\r\n\r\n"; fwrite($fp, $header.$soapPacket);
while (true) { $buffer = fread($fp, 1000); if( $buffer != "" ) $response .= $buffer; if(strstr($response, '</SOAP-ENV:Envelope>') || $buffer == "" ) break; $buffer = ""; } fclose($fp); $result = explode("<?xml",$response); return "<?xml".$result[1]; } }
|
Sample Response
|
<Response> <Method>SignUpUser</Method> <Status>true</Status> <ErrorCode>70500001</ErrorCode> <ErrorDescription>Operation completed successfully.</ErrorDescription> <Result/> </Response>
|