Registration API

This is the API of the Registration page. Use http post to pass the fields into the function. Response returned as json string.
In order to use the Registration API, call the DOMAIN/RealReg_json url. For the Demo registration, call the DOMAIN/DemoReg_json url.

Function Input

The input for this function is the New Client Record fields, plus some control fields. The last 3 fields in this list representing the client record.
Field Name Description
TP_Source Set the client Data Source field and decide which TP will open an account !
Lead_Source This parameter refers to affiliates and its value will be updated in the "Lead Supplier" field.
Aff_Num This parameter refers to affiliates and its value will be updated in the "Middleman Account" and "Middleman Name" fields accordingly.
If the Middleman account can not be found in the hyp_Suppliers table, this field will remain empty.
Confirm_InfoViaEmail This flag is receiving "Agree to receive information by Email" check-box boolean value.
Post field value as case sensitive string: 'yes' or 'no'
Confirm_TermsOfUse This flag is receiving "Terms of Use" check-box boolean value.
Post field value as case sensitive string: 'yes' or 'no'
Confirm_TradeContract This flag is receiving "Indenture Contract" check-box boolean value.
Post field value as case sensitive string: 'yes' or 'no'
LastName
Email
1stPhone		 Example of how to pass fields from the Clients table.
Please note: Any additional required field from the hyp_Clients table can be posted, if defined for this page in the Client record Fields Matrix.
The "TP_Source", "lead_source" and "aff_num" fields can be posted in addition to these fields.

Field Name Structure

The fields names (the Original names of Hyper) are received and displayed according to the following rules:
  • IF "json API Field Name" was manually configured, then it will be the field name.
  • The received fields names in API are filtered and can contain only letters, digits and the char '_'. Any other chars will be removed.
  • The separated words will be compounded, by using the Camel-Case method (capital letters at the beginning of each new word).
    For example: table field name "Last name" will be used as "LastName" in the API.
* Run these json functions without any parameter (except API token) to get an empty fields list.
All available fields will be presented, except the first 6 fields from the above list !
Please ignore the fields "ConfirmEmail" and "ConfirmPassword", they have no use with API, you need to validate the form before you send it...

Functions Error Messages

Response Code Message in English
3 API function does not exists.
4 Database Error on server side.
5 Technical Error on server side.
7 Please fill up all the required fields.
9 Please fill in the fields in the Acceptable Languages. (Acceptable Language List)
10 User is already connected on this session (Logged in).
50 E-mail address: (EMail Field Content) is not valid.
51 Phone number: (Phone Number Field Content) is not valid.
54 Registration is for people aged ("Verify Client Age above # years" setting) and older.
55 Your Password is not strong enought (At least 3 digits and 3 letters).
Leave them both empty for automatic password generation.
56 In order to register, User must read and accept the Terms of Use.
57 In order to create an account, User must read and accept the Commercial agreement.
58 Account is already exist (Real/Demo). Recommend password recovery tool.

Message Examples

Posted Http Form:
DOMAIN/RealReg_json?FirstName=John&Email=john@gmail.com

For successful registration, the following message will be received:
{"Registration":"OK","Cookie":"1400605290776E29A80E40FA"}

If any error occurs, the following message format will be received:
{"ResponseCode":"007","ResponseMsgEng":"please fill up all the required fields"}

An example for complete client registration (According to your CRM configuration, ignore the spaces next to the & char):
DOMAIN/RealReg_json?
LastName=Cramer & FirstName=John & Email=john@gmail.com & 1stPhone=13101234567 &
Confirm_InfoViaEmail=no & Confirm_TermsOfUse=yes & Confirm_TradeContract=yes &
lead_source=Facebook123456 & aff_num=10100

Differences between the API behaviour and the HTML form

  • The "aff_num" and "lead_source fields can be posted directly by the RealReg_json and DemoReg_json, with no need to use a different url (e.g. Affiliate_Registration).