The TapClassifieds Web Services are a collection of HTTP interfaces to services providing data for your applications.  In order to use these web services, you must request authorization for a public key and a secret key.  See the Authorization section below for more information.
Dealers By Agency Markets
This web service prints the agencies, their markets and the dealers under each market
Url
https://api.tapclassifieds.com/dealersByAgencyMarkets.php
Parameters
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/dealersByAgencyMarkets.php?keyId=mykey&sig=mysig
Sample output
A JSON string is printed with key 'agencies'. The value of 'agencies' is an array of objects having the below fields:
id - Agency id
code - Agency code name
name - Agency name
markets - List of markets
The value of key 'markets' is an array of objects having the below fields:
id - Market id
name - Market name
api - Object with api username and password fields encrypted.  Please use the secret key shared with you to decrypt the username/password fields. This secret key is NOT the same as the secret key for generating the signature of the url request. Use MCRYPT_RIJNDAEL_256 algorithm with ECB mode and safe base64 encode/decode.
dealers - List of dealers
The value of key 'dealers' is an array of objects having the below fields:
id - Dealer id
name - Dealer name
active - Boolean true is dealer active, false otherwise
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Provider List
This web service prints the list of providers
Url
https://api.tapclassifieds.com/providerList.php
Parameters
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/providerList.php?keyId=mykey&sig=mysig
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects having the below fields:
id - Provider id
code - Provider code
name - Provider name
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Dealer Info
This web service prints the dealer information, including the dealer's market / agency.
Url
https://api.tapclassifieds.com/dealerInfoById.php
Parameters
dealer - Dealer id (see how to get dealer Id)
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/dealerInfoById.php?keyId=mykey&sig=mysig&dealer=25580
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an object having the below fields:
id - Dealer id
name - Dealership name
street - Street address
city - City
state - State
zip - Zip code
timezone - Time Zone
site_link - Dealer' website url
dealer_email - Email address for leads forwarding
crm_email - CRM email address for leads forwarding
dealer_phone - Phone number for call leads forwarding
text_forward_number - Phone number for text leads forwarding
loc_lat - Dealership location latitude
loc_lng - Dealership location longitude
status - Dealer active status (E - active, D - disabled)
market_id - Market id (internal)
market_name - Market name
agency_id - Agency id (internal)
agency_name_short - Agency code
agency_name - Agency full name
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Dashboard Metrics - Dealer Level
This web service prints the dealer level dashboard metrics for a dealer for the given date range.
The start/end dates will be considered in the given dealer's timezone.
Url
https://api.tapclassifieds.com/dashboardMetrics.php
Parameters
dealer - Dealer id (see how to get dealer Id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
level - Pass it as 'dealer'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/dashboardMetrics.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2017-01-01&endDate=2017-01-01&level=dealer
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, where each object is for dashboard metrics for a date, and having the below fields:
seller_id - Dealer id
track_date - Metric recorded date (yyyy-mm-dd)
live_posted_cars - Number of cars posted on the day
posted_sold_cars - Number of cars sold on the day
landing_page_visits - VDP visits
mobile_landing_page_visits - Mobile VDP visits
lp_visits_direct - VDP visits directly from craigslist
lp_visits_google - VDP visits referral from google
lp_visits_facebook - VDP visits referral from facebook
lp_visits_yahoo - VDP visits referral from yahoo
lp_visits_bing - VDP visits referral from bing
lp_visits_other - VDP visits referral from other sites
mobile_lp_visits_direct - mobile VDP visits directly from craigslist
mobile_lp_visits_google - mobile VDP visits referral from google
mobile_lp_visits_facebook - mobile VDP visits referral from facebook
mobile_lp_visits_yahoo - mobile VDP visits referral from yahoo
mobile_lp_visits_bing - mobile VDP visits referral from bing
mobile_lp_visits_other - mobile VDP visits referral from other sites
srp_visits - search result page visits
received_calls - Unique call leads received
total_received_calls - Total call leads received
average_call_duration - Average call lead duration
unanswered_calls - Number of unanswered call leads
total_received_emails - Total email leads received
received_finance_apps - Finance app leads received
received_test_drive - Test drive leads received
received_webuycar - We buy cars leads received
dealer_website_clicked - Clicks to dealer's website from VDP
car_picture_clicked - Clicks to view more car pictures on VDP
car_details_clicked - Clicks to view more info on VDP
map_address_clicked - Clicks to get map directions on VDP
video_clicked - Clicks to view video on VDP
webuycar_clicked - Clicks to open we buy car form on VDP
finance_clicked - Clicks to finance page link from VDP
test_drive_clicked - Clicks to open test drive form on VDP
email_clicked - Clicks to open contact dealer form on VDP
print_map_clicked - Clicks to print map link on VDP
print_car_clicked - Clicks to print page link on VDP
chat_clicked - Clicks to chat with dealer on VDP
facebook_clicked - Clicks to facebook share icon on VDP
twitter_clicked - Clicks to twitter share icon on VDP
googleplus_clicked - Clicks to google plus share icon on VDP
pinterest_clicked - Clicks to pinterest share icon on VDP
carfax_clicked - Clicks to carfax link on VDP
total_leads_last_30_days - Total leads in the last 30 days
billable_cars_posted - Cars posted on Craigslist for the day
send_to_mobile_clicked - Clicks to send to mobile form on VDP
received_vehicle_value_check - Vehicle value check leads received
received_schedule_trade - Vehicle schedule trade leads received
live_sold_inventory - Number of cars sold for which ads were not deleted
received_emails - Unique email leads received
posting_cost - Posting cost for the day
unique_leads - Unique calls + text + email + chat + form leads
cost_per_lead - Cost per lead (posting_cost / unique_leads)
total_unanswered_leads - Total unanswered leads
new_chat_conversations - New chat conversations received
new_chat_customers - Received chat from new customers
active_chat_conversations - Active chat conversations
new_text_conversations - New text conversations received
new_text_customers - Received text from new customers
active_text_conversations - Active text conversations
new_formlead_conversations - New form conversations received
active_formlead_conversations - Active form conversations
dealer_vdp_visits - Dealer VDP visits
thirdparty_vdp_visits - Third party VDP visits
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Dashboard Metrics - Provider Level
This web service prints the provider level dashboard metrics for a dealer for the given date range.
The start/end dates will be considered in the given dealer's timezone.
Url
https://api.tapclassifieds.com/dashboardMetrics.php
Parameters
dealer - Dealer id (see how to get dealer Id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
level - Pass it as 'provider'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/dashboardMetrics.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2017-01-01&endDate=2017-01-01&level=provider
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, where each object is for dashboard metrics for a date, and having the below fields:
seller_id - Dealer id
track_date - Metric recorded date (yyyy-mm-dd)
provider_id - Provider id
provider_name - Provider name
live_posted_cars - Number of cars posted on the day
posted_sold_cars - Number of cars sold on the day
landing_page_visits - VDP visits
mobile_landing_page_visits - Mobile VDP visits
lp_visits_direct - VDP visits directly from craigslist
lp_visits_google - VDP visits referral from google
lp_visits_facebook - VDP visits referral from facebook
lp_visits_yahoo - VDP visits referral from yahoo
lp_visits_bing - VDP visits referral from bing
lp_visits_other - VDP visits referral from other sites
mobile_lp_visits_direct - mobile VDP visits directly from craigslist
mobile_lp_visits_google - mobile VDP visits referral from google
mobile_lp_visits_facebook - mobile VDP visits referral from facebook
mobile_lp_visits_yahoo - mobile VDP visits referral from yahoo
mobile_lp_visits_bing - mobile VDP visits referral from bing
mobile_lp_visits_other - mobile VDP visits referral from other sites
srp_visits - search result page visits
received_calls - Unique call leads received
total_received_calls - Total call leads received
average_call_duration - Average call lead duration
unanswered_calls - Number of unanswered call leads
total_received_emails - Total email leads received
received_finance_apps - Finance app leads received
received_test_drive - Test drive leads received
received_webuycar - We buy cars leads received
dealer_website_clicked - Clicks to dealer's website from VDP
car_picture_clicked - Clicks to view more car pictures on VDP
car_details_clicked - Clicks to view more info on VDP
map_address_clicked - Clicks to get map directions on VDP
video_clicked - Clicks to view video on VDP
webuycar_clicked - Clicks to open we buy car form on VDP
finance_clicked - Clicks to finance page link from VDP
test_drive_clicked - Clicks to open test drive form on VDP
email_clicked - Clicks to open contact dealer form on VDP
print_map_clicked - Clicks to print map link on VDP
print_car_clicked - Clicks to print page link on VDP
chat_clicked - Clicks to chat with dealer on VDP
facebook_clicked - Clicks to facebook share icon on VDP
twitter_clicked - Clicks to twitter share icon on VDP
googleplus_clicked - Clicks to google plus share icon on VDP
pinterest_clicked - Clicks to pinterest share icon on VDP
carfax_clicked - Clicks to carfax link on VDP
total_leads_last_30_days - Total leads in the last 30 days
billable_cars_posted - Cars posted on Craigslist for the day
send_to_mobile_clicked - Clicks to send to mobile form on VDP
received_vehicle_value_check - Vehicle value check leads received
received_schedule_trade - Vehicle schedule trade leads received
live_sold_inventory - Number of cars sold for which ads were not deleted
received_emails - Unique email leads received
posting_cost - Posting cost for the day
unique_leads - Unique calls + text + email + chat + form leads
cost_per_lead - Cost per lead (posting_cost / unique_leads)
total_unanswered_leads - Total unanswered leads
new_chat_conversations - New chat conversations received
new_chat_customers - Received chat from new customers
active_chat_conversations - Active chat conversations
new_text_conversations - New text conversations received
new_text_customers - Received text from new customers
active_text_conversations - Active text conversations
new_formlead_conversations - New form conversations received
active_formlead_conversations - Active form conversations
dealer_vdp_visits - Dealer VDP visits
thirdparty_vdp_visits - Third party VDP visits
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Active Vehicle List
This web service prints the list of all active vehicles for the given dealer. The date/time values in this web service are in the GMT timezone.
Url
https://api.tapclassifieds.com/activeVehicles.php
Parameters
dealer - dealer id (see how to get dealer Id)
keyId - public key id (see how to get key id)
sig - signature generated (see how to generate signature)
providerCode - provider code (optional - see how to get provider code )
Example
without provider
https://api.tapclassifieds.com/activeVehicles.php?keyId=mykey&sig=mysig&dealer=25580
with provider
https://api.tapclassifieds.com/activeVehicles.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
car_id - Vehicle id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
provider_code - Provider Code
year - Year
make - Make
model - Model
car_posting_url - Ad url
PRICE - Price
STOCK_NUMBER - Stock number
first_posted_time - First posted time (yyyy-mm-dd hh:mm:ss)
last_repost_time - Latest time when ad marked as expired (yyyy-mm-dd hh:mm:ss)
car_posted_time - Latest ad posted time (yyyy-mm-dd hh:mm:ss)
lp_url - VDP url
thumbnail_url - Vehicle thumbnail image
VIN - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Sold Vehicle List
This web service prints the list of all sold vehicles for the given dealer in the given date range. The date/time values in this web service are in the GMT timezone.
Url
https://api.tapclassifieds.com/soldVehicles.php
Parameters
dealer - dealer id (see how to get dealer Id)
startDate - start date in format yyyy-mm-dd
endDate - end date in format yyyy-mm-dd
keyId - public key id (see how to get key id)
sig - signature generated (see how to generate signature)
providerCode - provider code (optional - see how to get provider code )
Example
without provider
https://api.tapclassifieds.com/soldVehicles.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2018-01-01&endDate=2018-04-01
with provider
https://api.tapclassifieds.com/soldVehicles.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2018-01-01&endDate=2018-04-01&providerCode=CL
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
car_id - Vehicle id
provider_id - Provider id
provider_code - Provider code
account_id - Account id
campaign_id - Campaign id
year - Year
make - Make
model - Model
PRICE - Price
STOCK_NUMBER - Stock number
car_sold_time - Ad deletion time (yyyy-mm-dd hh:mm:ss)
lp_url - VDP url
thumbnail_url - Vehicle thumbnail image
car_posted_time - Latest Car Posted Time (yyyy-mm-dd hh:mm:ss)
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Ads Posted List
This web service prints the list of ads posted for the given dealer. The date/time values in this web service are in the GMT timezone.Currently this api call supports only CL and LG providers.
Url
https://api.tapclassifieds.com/adsPostedDetails.php
Parameters
dealer - dealer id (see how to get dealer Id)
keyId - public key id (see how to get key id)
startDate - start date in format yyyy-mm-dd
endDate - end date in format yyyy-mm-dd
sig - signature generated (see how to generate signature)
providerCode - provider code (optional - see how to get provider code )
Example
without provider
https://api.tapclassifieds.com/adsPostedDetails.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2018-01-01&endDate=2018-04-01
with provider
https://api.tapclassifieds.com/adsPostedDetails.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2018-01-01&endDate=2018-04-01&providerCode=CL
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
car_id - Vehicle id
account_id - Account id
car_posting_url - Ad url
status - ad status (ex: active,sold,expired,deleted)
type - posting type ex: (cl_posting, lg_posting)
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Campaign List
This web service prints the list of all the campaigns (historical) for the given dealer.
Url
https://api.tapclassifieds.com/campaignList.php
Parameters
dealer - dealer id (see how to get dealer Id)
provider - provider id (optional - see how to get provider id)
onlyActive - If set to 'yes', returns only currently active campaigns
keyId - public key id (see how to get key id)
sig - signature generated (see how to generate signature)
Example
without provider
https://api.tapclassifieds.com/campaignList.php?keyId=mykey&sig=mysig&dealer=25580
with provider
https://api.tapclassifieds.com/campaignList.php?keyId=mykey&sig=mysig&dealer=25580&provider=1
with active only
https://api.tapclassifieds.com/campaignList.php?keyId=mykey&sig=mysig&dealer=25580&onlyActive=yes
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
id - Campaign id
name - Campaign name
start - Start date in format (yyyy-mm-dd)
end - End date (null if recurring campaign) in format (yyyy-mm-dd)
isRecurring - true if campaign recurring
status - One of active, paused, deleted, expired
scheduleInfo - Object containing info about specific times of week/day when the campaign runs
dailyPostingGoal - Ideal number of vehicles to post per day
monthlyPosts - Max number of vehicles to post per month
provider - Provider information (object with keys id and code)
options - Campaign options (sort order, dupe posting etc)
postingRegion - The regions where the ads will be posted
trackingNumbers - Lead tracking call/text phone numbers
filters - Campaign filters and their settings
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Email Leads
This web service prints the list of email leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign Id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'email'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-05&endDate=2016-01-05&type=email
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2016-01-05&endDate=2016-01-05&type=email
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2016-01-05&endDate=2016-01-05&type=email
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
email_lead_id - Email lead id - unique Id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
lead_received_time - Timestamp when lead received
customer_name - Customer's Name
customer_email - Customer's Email
customer_phone - Customer's Phone, if present
email_subject - Subject of email
email_content - Content of email
vehicle_id - Vehicle id
vehicle - Vehicle Year Make Model
thumbnail_url - Vehicle thumbnail url
stock_number - Vehicle stock number
landing_page_link - VDP url
caller_region - Customer's region
caller_state - Customer's state
ad_region - Campaign region
ad_state - Campaign state
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Text Leads
This web service prints the list of text leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider Code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'text'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-01&endDate=2016-12-31&type=text
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2016-01-01&endDate=2016-12-31&type=text
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2016-01-01&endDate=2016-12-31&type=text
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
text_lead_id - Text lead id - unique id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
vehicle_id - Vehicle id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
chat_owner_id - Conversation Id
lead_received_time - Timestamp when leads received
message_id - message id
text_subject - Subject of text message
text_message - Content of text message
text_back_link - URL to view customer's text conversations
tracking_number - Tracking number shown on ads
customer_number - Customer's Phone Number
caller_region - Customer's region
caller_state - Customer's state
ad_region - Campaign region
ad_state - Campaign state
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Call Leads
This web service prints the list of call leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'phone'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-01&endDate=2016-12-31&type=phone
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2016-01-01&endDate=2016-12-31&type=phone
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2016-01-01&endDate=2016-12-31&type=phone
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
phone_lead_id - Call lead id - unique id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
car_id - Vehicle id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
call_start_time - Timestamp when leads received
call_end_time - Timestamp when call ended
call_duration - Call duration in seconds
call_status - Status of the call (ex: ANSWER)
customer_number - Customer's Phone Number
customer_name - Customer's Name
recorded - Whether call was recorded (1 - Yes, 0 - No)
call_listen_link - Url to play the recorded call
call_download_link - Url to download the recorded call
tracking_number - Tracking number shown on ads
caller_region - Customer's region
caller_state - Customer's state
ad_region - Campaign region
ad_state - Campaign state
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Chat Leads
This web service prints the list of chat leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
vehicle - vehicle id (optional - see how to get active vehicle id or how to get sold vehicle id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'im'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-01&endDate=2016-12-31&type=im
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2016-01-01&endDate=2016-12-31&type=im
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2016-01-01&endDate=2016-12-31&type=im
with vehicle
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&vehicle=4686615&startDate=2016-01-01&endDate=2016-12-31&type=im
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
text_lead_id - Chat lead id - unique id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
vehicle_id - Vehicle id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
chat_owner_id - Conversation Id
lead_received_time - Timestamp when leads received
message_id - message id
message - Content of text message
reply_link -URL to view customer's chat conversations
customer_id - Chat user Id
tracking_number - Tracking number shown on ads
customer_name - Customer's Name
customer_email - Customer's Email (might be null)
customer_phone - Customer's phone (might be null)
If vehicle_id is not null, then we also return the key 'vehicle_details', whose value is an object as shown below:
title - Vehicle title
vin - VIN number
stock_number - Stock number
days_in_inventory - Number of days the vehicle was in the inventory
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Credit App Leads
This web service prints the list of credit app leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'creditapp'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-01&endDate=2016-12-31&type=creditapp
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2016-01-01&endDate=2016-12-31&type=creditapp
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2016-01-01&endDate=2016-12-31&type=creditapp
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
creditapp_lead_id - Credit app lead id - unique Id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
lead_received_time - Timestamp when leads received
customer_name - Customer's Name
customer_email - Customer's Email
customer_number - Customer's Phone Number
vehicle_id - Vehicle id
stock_number - Stock Number
vehicle - Vehicle Year Make Model
thumbnail_url - Vehicle thumbnail image url
landing_page_link - VDP url
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Form Leads
This web service prints the list of form leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/leadList.php
Parameters
dealer - Dealer id (see how to get dealer id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
vehicle - Vehicle id (optional - see how to get active vehicle id or how to get sold vehicle id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
type - Pass it as 'form'
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2020-04-01&endDate=2020-04-20&type=form
with campaign
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2020-04-01&endDate=2020-04-20&type=form
with provider
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2020-04-01&endDate=2020-04-20&type=form
with vehicle
https://api.tapclassifieds.com/leadList.php?keyId=mykey&sig=mysig&dealer=25580&vehicle=4686615&startDate=2020-04-01&endDate=2020-04-20&type=form
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
lead_id - Form lead id - unique id
dealer_id - Dealer id
account_id - Account id
campaign_id - Campaign id
provider_id - Provider id
vehicle_id - Vehicle id
lead_source - Campaign source of the lead (ex: craigslist)
lead_status - Status of the lead (ex: Active)
conversationId - Conversation Id
lead_received_time - Timestamp when leads received
message_id - message id
message - Content of text message
reply_link - URL to view customer's chat conversations
tracking_number - Tracking number shown on ads
customer_name - Customer's Name
customer_email - Customer's Email (might be null)
customer_phone - Customer's phone (might be null)
If vehicle_id is not null, then we also return the key 'vehicle_details', whose value is an object as shown below:
title - Vehicle title
vin - VIN number
stock_number - Stock number
days_in_inventory - Number of days the vehicle was in the inventory
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
VDP Visits
This web service prints the list of VDP visits for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/vdpVisits.php
Parameters
dealer - Dealer id (see how to get dealer Id)
providerCode - Provider code (optional - see how to get provider code)
campaign - Campaign id (optional - see how to get campaign id)
vehicle - Vehicle id (optional - see how to get active vehicle id or how to get sold vehicle id)
startDate - Start date in format yyyy-mm-dd
endDate - End date in format yyyy-mm-dd
page - The page number, starting from 1. Each page (api call) will have atmost 50 result entries.
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
default link
https://api.tapclassifieds.com/vdpVisits.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2020-04-01&endDate=2020-04-20&page=1
with campaign
https://api.tapclassifieds.com/vdpVisits.php?keyId=mykey&sig=mysig&dealer=25580&campaign=3&startDate=2020-04-01&endDate=2020-04-20&page=1
with provider
https://api.tapclassifieds.com/vdpVisits.php?keyId=mykey&sig=mysig&dealer=25580&providerCode=CL&startDate=2020-04-01&endDate=2020-04-20&page=1
with vehicle
https://api.tapclassifieds.com/vdpVisits.php?keyId=mykey&sig=mysig&dealer=25580&vehicle=4686615&startDate=2020-04-01&endDate=2020-04-20&page=1
Sample output
A JSON string is printed with keys 'nextPageNum' which could be null if there are no more pages of results, and a key 'data' which is an array of objects, with each object having below fields:
visit_time - Time of visit
ip_address - IP address
vehicle_id - Vehicle id
account_id - Account id
source - Visit source
campaign_id - Campaign id
provider_id - Provider id
provider_code - Provider code
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Vehicle Level Leads / Engagements
This web service prints the vehicle level leads for the given dealer between the given dates.
The start/end dates will be considered as the dates in the given dealer's timezone.
Url
https://api.tapclassifieds.com/vehicleLeads.php
Parameters
dealer - Dealer id (see how to get dealer Id)
provider - Provider id
startDate - Start Date in format yyyy-mm-dd
endDate - End Date in format yyyy-mm-dd
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
Example
https://api.tapclassifieds.com/vehicleLeads.php?keyId=mykey&sig=mysig&dealer=25580&provider=1&startDate=2016-01-01&endDate=2016-12-31
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having the below fields:
date - Metrics record time (yyyy-mm-dd)
car_id - Vehicle id
seller_id - Dealer id
account_id - Account id
provider_id - Provider id
landing_page_visits - VDP visits
mobile_landing_page_visits - Mobile VDP visits
qr_code_scans - Number of QR code scans from VDP (deprecated, might be removed in future version)
dealer_website_clicked - Clicks to dealer's website from VDP
pictures_viewed - Clicks to view more car images on VDP
location_viewed - Clicks to view dealership address link on VDP
maps_printed - Clicks to print map link on VDP
email_leads - Number of email leads
call_leads - Number of call leads
testdrive_leads - Number of test drive leads
finapp_received - Number of finance app leads
vin - Vehicle identification number
dealer_vdp_visits - Dealer VDP visits
thirdparty_vdp_visits - Third party VDP visits
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Customer Enquiry Leads
This web service prints the list of Customer Enquiry leads for the given dealer between given dates.
The date/time fields in the response are all in the dealer's timezone.
Url
https://api.tapclassifieds.com/getCustomerEnquiries.php
Parameters
dealer - Dealer id (see how to get dealer Id)
startDate - Start Date in format yyyy-mm-dd
endDate - End Date in format yyyy-mm-dd
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
providerCode - Provider Code (optional - see how to get provider code)
Example
without provider
https://api.tapclassifieds.com/getCustomerEnquiries.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-05&endDate=2016-01-05
with provider
https://api.tapclassifieds.com/getCustomerEnquiries.php?keyId=mykey&sig=mysig&dealer=25580&startDate=2016-01-05&endDate=2016-01-05&providerCode=CL
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
leadId - customer enquiry id (unique id)
providerId - provider id
providerCode - provider code
vehicleId - vehicle id
leadSource - source where leads arrived from VDP forms (ex: craigslist,tapclassifieds)
leadTime - lead received time
customerName - customer name
customerEmail - customer email
customerPhone - customer phone
message - customer enquiry message
vin - Vehicle identification number
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Dealer By Zipcode Lookup
This web service prints the list of dealers based on given zipcode.
Url
https://api.tapclassifieds.com/dealersZipcodeLookup.php
Parameters
keyId - public key id (see how to get key id)
sig - signature generated (see how to generate signature)
zipcode - zipcode
radius - radius (optional - values to be passed 25 or 50 (by default 25 will be considered ,if radius param not passed.))
Example
without radius
https://api.tapclassifieds.com/dealersZipcodeLookup.php?keyId=mykey&sig=mysig&zipcode=94596
with radius
https://api.tapclassifieds.com/dealersZipcodeLookup.php?keyId=mykey&sig=mysig&zipcode=94596&radius=25
Sample output
A JSON string is printed with key 'data'. The value of 'data' is an array of objects, with each object having below fields:
dealerName - Dealer Name
street - Street
city - City
state - State
country - Country
zipcode - Zipcode
In case of any error, a JSON string is printed with key 'err'. The value of 'err' is a string with the error message.
Sample Link
Get Carbo Followup Config API
This web service will return the carbo followup config details.
Url
https://api.tapclassifieds.com/getCarboFollowupConfig.php
Parameters
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
dealerId - '<DEALER_ID>'
providerCode - 'FBMKT'
Sample Response
success - {"msg":{"carboFollowupMethod":"custom","carboFollowupDetails":[{"followupTime":"12","followupTimeUnit":"hours","followupText":"test fbmkt","fid":"1"}]}}
error - {"err":"{messages}"}
Sample Error Messages
Access denied - do not have a access
Invalid signature - signature is invalid
Invalid request - params missing
Invalid key - key is invalid
Post Lead API
This web service will receive the leads .
Method

Post

Url
https://api.tapclassifieds.com//lead/{LeadType}/add

{leadType} is one of email/text/chat/form/call

Parameters
keyId - Public key id (see how to get key id)
sig - Signature generated (see how to generate signature)
dealerId - '<DEALER_ID>'
providerCode - 'SD'
lead - '<ADF_FORMAT_DATA>'

For ADF format please check this link - http://adfxml.info/adf_spec.pdf
Sample Post Request
{"lead":"2000-03-30T15:30:20-08:00<\/requestdate>1999<\/year>Chevrolet<\/make>Blazer<\/model><\/vehicle>John Doe<\/name>393-999-3922<\/phone><\/contact><\/customer>Acura of Bellevue<\/name><\/contact><\/vendor><\/prospect><\/adf>"}
Sample Post Response
success - {"msg":"success"}
error - {"err":"{messages}"}
Sample Error Messages
Access denied - do not have a access
Invalid signature - signature is invalid
Invalid request - params missing
Invalid key - key is invalid
Authorization
To get a key id and secret key value, please send us an email at:  support@tapclassifieds.com
Signature algorithm
All TapClassifieds web services use the below algorithm to generate signature:
Step-1:  Put all the parameters, except 'sig', from the parameters section defined for your web service into an array
Step-2:  Sort the array by key, maintaining key-value pairs correlation
Step-3:  Generate a URL-encoded query string using the array resulting from step-2
Step-4:  Generate the signature using HMAC-SHA1 algorithm.  The inputs to the algorithm are the query string and the  secret key value shared with you by TapClassifieds.
NOTE: The output from the HMAC-SHA1 algorithm should be in raw format,  and not as a hex string
Step-5:  Base64 encode the output from step-4, and urlencode it and you will get the signature
NOTE: This signature has to be passed to any web service in the 'sig' parameter
<?php
/*
* The below code demonstrates signature generation logic for the web service 'Dashboard Metrics - Dealer Level'
**/

//build your param array with all the params for your web service shown under 'Parameters' section, except the 'sig' param
$secret = 'yourapisecret';
$params = array(
    'keyId' => 'yourapikey',
    'dealer' => 1111,
    'level' => 'dealer',
    'startDate' => '2019-04-01',
    'endDate' => '2019-04-30'
);

//sort the array by key (ascending order) and maintain the key/value pairs association
ksort($params);

//generate url-encoded query string from the params array
$queryString = http_build_query($params);

//generate a one-way hash using SHA-1 algorithm (hash function must return raw binary data)
//pass the hash through Base-64 encoding, and then through url-encode to get the signature
$signature = urlencode(base64_encode(hash_hmac('sha1', $queryString, $secret, TRUE)));
echo $signature; //hLeucA7rdmy5kqGrCfMSnMpeP28=
<?php
/*
* The below code demonstrates signature generation logic for the web service 'Dashboard Metrics - Dealer Level'
**/

//include the required libraries
var httpBuildQuery = require('http-build-query');
var crypto = require('crypto');
var urlencode = require('urlencode');

//build your param array with all the params for your web service shown under 'Parameters' section, except the 'sig' param
var secret = 'yourapisecret';
var params = {
    'keyId' : 'yourapikey',
    'dealer' : 1111,
    'level' : 'dealer',
    'startDate' : '2019-04-01',
    'endDate' : '2019-04-30'
};

//sort the array by key (ascending order) and maintain the key/value pairs association
var ordered = {};
Object.keys(params).sort().forEach(function(key) {
    ordered[key] = params[key];
});

//generate url-encoded query string from the params array
var queryString = httpBuildQuery(ordered);

//generate a one-way hash using SHA-1 algorithm
//pass the hash through Base-64 encoding, and then through url-encode to get the signature
var signature = urlencode(crypto.createHmac('sha1', secret).update(queryString).digest('base64'));
console.log(signature); //hLeucA7rdmy5kqGrCfMSnMpeP28=