Official documentation for Anarock Leads API! You can use this set of APIs for pushing leads to host (passed with request object) database.
For any queries mail us at [email protected]
Code for creating hash using time_stamp. Hash is required to authenticate proper usage.
// PHP
$key = 'KEY'; // the shared secret key here
$current_time = time();
$message = (string)$current_time;
// to lowercase hexits
$hash = hash_hmac('sha256', $message, $key);// NodeJS
const cryto = require('crypto');
const key = 'KEY'; // the shared secret key here
const time_stamp = Math.round((new Date()).getTime() / 1000);
const message = time_stamp.toString();
const hash = crypto.createHmac('sha256', key).update(message);
// to lowercase hexits
const hashInHex = hash.digest('hex');# ruby
auth_key = 'Key'
current_time = Time.current.to_i
hash = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), auth_key, current_time.to_s)Make sure to replace
KEYwith your API key.
Server uses SHA256 HMAC authentication method. The hash is created using current timestamp and your key as parameters.
Server expects two keys hash and current_time to be included in all API requests to server.
This will be provided by your point of contact in ANAROCK team. Or you can request key by getting in touch with support team at [email protected]
You must replace KEY with your personal API key.
You must test first with staging KEY and then only put in _production KEY
// PHP
$api_url = 'STAGING OR PRODUCTION URL'; // as mentioned on left under HTTP Request Heading
$key = 'KEY';
$current_time = time();
$message = (string)$current_time;
// to lowercase hexits
$hash = hash_hmac('sha256', $message, $key);
// you can use libraries like https://github.com/brick/phonenumber to format numbers before sending
$number = PhoneNumber::parse('+447123456789'); // phone number of the lead with +
$country_code = $number->getRegionCode(); // GB
$phone = $number->getNationalNumber(); // 7123456789
$campaign_id = "UniqueString"; // String to Attribute the lead to specific project. contact ANAROCK team for this.
$postFields = "";
$postFields .= "&name=".$name; // refer to query parameters section on left section
$postFields .= "&email=".$email;
$postFields .= "&source=".$utm_source;
$postFields .= "&sub_source=".$utm_campaign;
$postFields .= "&placement=".$utm_term;
$postFields .= "&purpose=buy";
$postFields .= "¤t_time=".$current_time;
$postFields .= "&phone=".$phone; // Phone number without country code
$postFields .= "&country_code=".$country_code; // Standard ISO3166-1 alpha-2 code for a country.
$postFields .= "&hash=".$hash; // its mandatory to create hash using same timestamp as sent in current_time parameter
$postFields .= "&campaign_id=".$campaign_id;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$api_url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
$postFields);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
// print_r($server_output);// Javascript
const crypto = require('crypto');
const PhoneNumber = require( 'awesome-phonenumber' );
const axios = require('axios'); // using axios to make post request, you can use any other method/library you are comfortable with
const timeStamp = Math.round((new Date()).getTime() / 1000);
const message = timeStamp.toString()
const hash = crypto.createHmac('sha256', key).update(message).digest('hex')
const number = new PhoneNumber(number.toString()); // pass the number with + to the PhoneNumber Library
const phone = number.getNumber('significant');
const country_code = number.getRegionCode();
const campaign_id = 'UniqueString';// String to Attribute the lead to specific project. contact ANAROCK team for this.
return axios({
url: 'STAGING OR PRODUCTION URL', // as mentioned on left under HTTP Request Heading
method: 'POST',
data: {
phone: phone,
country_code: country_code,
current_time: timeStamp,
hash: hash,
campaign_id: campaign_id,
...other fields as given in the query parameters section
}
})#Ruby
current_time = Time.current.to_i;
prod_key = PROD_KEY;
hash = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), prod_key, current_time.to_s);
params = {
:name=>"ketan",
:email=>"[email protected]",
:purpose=>"buy",
:phone=>"9819619866",
:country_code=>"in",
:current_time=> current_time,
:hash=> hash,
:campaign_id=>"42-Queens-Square-Sell-Do-Leads",
:source_id=>1,
:sub_source_id=>6,
:channel_name=>"sell-do"
};
uri = URI.parse(url);
http = Net::HTTP.new(uri.host, uri.port);
http.use_ssl = true;
request = Net::HTTP::Post.new(uri.request_uri);
request.add_field('Content-Type', 'application/json');
request.body = params.to_json;
response = http.request(request);The above command returns JSON structured like this:
{
"status":"OK",
"message":"success",
"response":
{
"lead_id": 17863
}
}This endpoint is used to post a lead to HOST database.
staging
POST https://lead-webhook.staging.${HOST}/api/v0/CHANNEL_NAME/sync-lead
--
production
POST https://lead.${HOST}/api/v0/CHANNEL_NAME/sync-lead
Authentication keys are environment specific. Make sure you are using Staging KEY in Staging environment and Production KEY in Production environment
example HOST: anarock.com
This will be provided by your point of contact from ANAROCK support team
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| name | String | - | Example "Rahul Kumar" |
| phone | String | True | phone number without country code. Example: "9988998899" |
| country_code | String | True | Standard ISO3166-1 alpha-2 code for a country. Link: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 You can also use libraries like, example: "IN" for India Defaults to "IN" |
| String | - | Exmaple "[email protected]" | |
| purpose | String | True | "buy" This should be hardcoded |
| listing_id | String | - | Id of the product/listing/project/property for which lead is generated. Example: "111" |
| listing_name | String | - | name of the project/property for which lead is generated. Example: "Runwal Green" |
| current_time | Integer | True | current epoch time in second(notmilisecond) Link: https://www.epochconverter.com/clock |
| hash | String | True | Generated in the section above Hash should be created using the same time stamp as sent in the parameter current_time |
| city | String | - | Example "Mumbai" |
| locality | String | - | Example "Bandra West" |
| min_budget | Integer | - | exmaple 10000000 |
| max_budget | Integer | - | exmaple 50000000 |
| contact_date | Integer | - | epoch time(in second) at which lead has contacted |
| remarks | String | - | additional comment about lead |
| homeloan_required | Boolean | - | whether the lead is interested in home loan or not |
| is_otp_verified | Boolean | - | whether the lead is OTP verified or not |
| is_call_verified | Boolean | - | whether the lead is Call verified or not |
| credit_value | Stirng | - | credit/ cost of the lead. Exmaple: "250" |
| is_broker | Boolean | - | whether the lead submitted is of a broker or not |
| apartment_types | String | - | comma separated bhk types where bhk type can be 1bhk/2bhk/3bhk/3+bhk/1rk) example: "2bhk,3+bhk" |
| source | String | - | google, facebook, affiliate, emailer, linkedin, portals,twitter, etc - this field should always contain primary origin or lead |
| sub_source | String | - | google_display, google_search, facebook_brands, facebook_lead_gen, affiliate - this should identify the type of campaign either branding or performance |
| placement | String | - | utm_campaign , affiliate_name e.g. taboola, nestoria, polyvalent, times_of_india, portal_name e.g. 99acres, magicbricks, housing - this should tell exact campaign details be it google facebook etc. generally you should pass utm_campaign in this |
| extra_details | JSON | - | key-value pair which will contain any extra details for lead e.g. {"utm_medium: "something", "utm_source": "something", "keyword": "targetted keyword on google for the campaign"} |
| campaign_id | String | True | The is a unique identifier for the project you are sending the lead for. Should be collected from point of contact in ANAROCK team. Without this lead attribution will be incorrect. |
Remember — without proper campaign_id, leads will not be attributed to the correct project team. Always check with your point of contact that leads are attributed to the desired project only.
Please format phone numbers before sending using one of the libraries below
| Language | Link |
|---|---|
| PHP | https://github.com/brick/phonenumber |
| NodeJS | https://www.npmjs.com/package/awesome-phonenumber |
// PHP
$key = 'KEY';
$current_time = time();
$message = (string)$current_time;
// to lowercase hexits
$hash = hash_hmac('sha256', $message, $key);
$phone = 9999999999 // Phone number to test
$api_url = "https://lead-webhook.staging.<HOST>/api/v0/CHANNEL_NAME/last-lead-data?phone="+$phone+"¤t_time="+$current_time+"&hash="+$hash
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
// print_r($server_output);// NodeJS
const crypto = require('crypto');
const timeStamp = Math.round((new Date()).getTime() / 1000);
const message = timeStamp.toString()
const hash = crypto.createHmac('sha256', key).update(message).digest('hex')
const phone = 9999999999 // valid mobile number
const host = 'anarock.com' // use correct host url
axios({
method: "GET",
url: `https://lead-webhook.staging.${host}/api/v0/CHANNEL_NAME/last-lead-data?phone=${phone}¤t_time=${timeStamp}&hash=${hash}`
})This API will respond with following structured JSON:
{
"status":"OK",
"message":"success",
"response":{
"lead_id":194466,
"name":"name",
"email":"[email protected]",
"phone":"+9199999999",
"country_code":"+91",
"source":null,
"sub_source":null,
"placement":null,
"extra_details":null,
"project_name":"bkc test",
"source_id": 1,
"sub_source_id": 10
}
}
}To check if a lead has been successfully submitted with all parameters captured correctly.
Use the following GET API
staging
https://lead-webhook.staging.<HOST>/api/v0/CHANNEL_NAME/last-lead-data?phone=PHONE_NUMBER¤t_time=CURRENT_TIME&hash=HASH
--
production
https://lead.<HOST>/api/v0/CHANNEL_NAME/last-lead-data?phone=PHONE_NUMBER¤t_time=CURRENT_TIME&hash=HASH
Please ensure that you are getting the project name intended in the reponse given on the right.