My buyer rating      Feedback
   
Review a Buyer Screen a Buyer Integration Tools Seller Tips Q&A Message Board Testimonials About Us
API Integration Guide

How to integrate the API?

STEP 1  Log in eBuyersReviewed and click on the API settings section (Figure 1).

Figure 1

 

STEP 2  Click on the Re-generate API Key button in case you need another API key. The API key is required for authentication (Figure 2).

Figure 2

 

We recommend testing the API by using the code from the “Test API key” row. The test mode allows unlimited test reviewing and screening, without using your screening credits. To switch from test to live mode, you need to use the iframe code  from the “Production API key” row. This will enable the real time reviewing and screening features of the tool.

 

STEP 3  Code implementation

 

[REGISTRATION]

Request URL:

https://www.ebuyersreviewed.com/api/registration/

Request data (JSON):

{
	"first_name":"John",
	"last_name":"Doe",
	"email":"john.doe@gmail.com",
	"phone":"555 555 555",
	"userpass":"******",
	"terms":"1"
}

 

Request variables description:

NameTypeDescription
first_name string Cusomer's first name [required]
last_name string Cusomer's last name [required]
email string Cusomer's email address [required]
phone string Cusomer's telephone [required]
userpass string Cusomer's password [required]
terms boolean Terms of service agreement, values: 0/1 [required]

 

Response data (JSON):

{
	"api_key":"4608218B-6CD3-B740-10FA-9B9232F7242E"
}

 

Response variables description:

NameTypeDescription
api_key string eBuyersReviewed authentication key

 

 

[LOGIN]

Request URL:

https://www.ebuyersreviewed.com/api/login/

Request data (JSON):

{
	"email":"john.doe@gmail.com",
	"password":"******"
}

 

Request variables description:

NameTypeDescription
email string Cusomer's email address [required]
password string Cusomer's password [required]

 

Response data (JSON):

{
	"api_key":"4608218B-6CD3-B740-10FA-9B9232F7242E",
	"data":[{
		"id":"1374",
		"email":"john.doe@gmail.com",
		"first_name":"John",
		"last_name":"Doe",
		"phone":"",
		"address":"",
		"city":"",
		"state":"",
		"zip":"",
		"country":"US",
		"company":"Company name",
		"customer_type":"user",
		"wallet_balance":"0.00",
		"membership":"1",
		"membership_start":"2017-07-10 01:30:55",
		"membership_period_start":"2017-07-10 01:30:55",
		"membership_period_end":"2017-08-10 01:30:55",
		"membership_expire":"",
		"membership_automatic_renewal":"0",
		"screenings":"30",
		"extra_screenings":"0",
		"promo_screenings":"0",
		"promo_screenings_per_month":"",
		"registered":"2017-07-10 01:30:55",
		"active":"1",
		"ip":"128.142.150.226",
		"reviews":"0",
		"neutral_reviews":""
	}]
}

 

Response variables description:

NameTypeDescription
api_key string eBuyersReviewed authentication key
data object array Logged cusomer's account details

 

 

[PASSWORD FORGOTTEN]

Request URL:

https://www.ebuyersreviewed.com/api/forgotPassword/

Request data (JSON):

{
	"email":"john.doe@gmail.com",
}

 

Request variables description:

NameTypeDescription
email string Cusomer's email address [required]

 

Response data (JSON):

{
	"msg":"The new password is sent to your E-mail",
	"error":"This email address is not registered in our system!"
}

 

Response variables description:

NameTypeDescription
msg string Succes message
error string Error message

 

 

[TERMS OF SERVICE AND PRIVACY POLICY TEXTS]

Request URL:

https://www.ebuyersreviewed.com/api/textPages/

Request data (JSON):

{
	"page_code":"privacy_policy",
}

 

Request variables description:

NameTypeDescription
page_code string values: privacy_policy / terms_of_service [required]

 

Response data (JSON):

{
	"data":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sem tortor...",
}

 

Response variables description:

NameTypeDescription
data string Text

 

 

[READ PROFILE DATA]

Request URL:

https://www.ebuyersreviewed.com/api/getProfile/

Request data (JSON):

{
	"page_code":"privacy_policy",
}

 

Request variables description:

NameTypeDescription
api_key string eBuyersReviewed authentication key [required]

 

Response data (JSON):

{
	"data":[{
		"id":"1374",
		"email":"john.doe@gmail.com",
		"first_name":"John",
		"last_name":"Doe",
		"phone":"",
		"address":"",
		"city":"",
		"state":"",
		"zip":"",
		"country":"US",
		"company":"Company name",
		"customer_type":"user",
		"wallet_balance":"0.00",
		"membership":"1",
		"membership_start":"2017-07-10 01:30:55",
		"membership_period_start":"2017-07-10 01:30:55",
		"membership_period_end":"2017-08-10 01:30:55",
		"membership_expire":"",
		"membership_automatic_renewal":"0",
		"screenings":"30",
		"extra_screenings":"0",
		"promo_screenings":"0",
		"promo_screenings_per_month":"",
		"registered":"2017-07-10 01:30:55",
		"active":"1",
		"ip":"128.142.150.226",
		"reviews":"0",
		"neutral_reviews":"" 
	}]
}

 

Response variables description:

NameTypeDescription
data object array Logged cusomer's account details

 

 

[SAVE PROFILE DATA]

Request URL:

https://www.ebuyersreviewed.com/api/setProfile/

Request data (JSON):

{
	"api_key":"4608218B-6CD3-B740-10FA-9B9232F7242E",
	"first_name":"John",
	"last_name":"Doe",
	"email":"john.doe@gmail.com",
	"phone":"555 555 555",
	"company":"Company name",
	"old_userpass":"******",
	"userpass":"******",
	"userpass_confirm":"******"
}

 

Request variables description:

NameTypeDescription
api_key string eBuyersReviewed authentication key [required]
first_name string Cusomer's first name [required]
last_name string Cusomer's last name [required]
email string Cusomer's email address [required]
phone string Cusomer's telephone [required]
company string Cusomer's company name [optional]
old_userpass string Cusomer's current password [optional]
userpass string Cusomer's new password [optional]
userpass_confirm string Cusomer's new password confirm [optional]

 

Response data (JSON):

{
	"msg":"Changes to your profile were saved.",
	"error":"Error message"
}

 

Response variables description:

NameTypeDescription
msg string Succes message
error string Error message

 

 

[GETTING ACCOUNT STATUS]

Request URL:

https://www.ebuyersreviewed.com/api/auth/

 

request data (JSON):

{
	"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB"
}

 

response data (JSON):

{
	"data": {
		"customer_name":"Allen Botz",
		"screenings":681,
		"membership":2,
		"membership_name":"Premium",
		"membership_expire":"Jul 24, 2015",
		"test_mode":1,
		"message":null,
		"disable_screenings":0
	}
}

 

Variables description:

NameTypeDescription
customer_name string Buyer's name
screenings integer Remaining screening credits of the user’s account
membership string

Membership type (digitally defined):

"1" - basic
"2" - premium
"3" - corporate
membership_name string Membership type (text)
membership_expire string Membership expiration date
test_mode integer "0" - production mode
"1" - test mode
message string  
disable_screenings integer "0" – insufficient screening credits
"1" - screening is disabled.


Examples:

Following are two examples of how you can test the API using jQuery or PHP:

 

[jQuery AJAX]

$.ajax({
	type : "GET",
	url : "https://www.ebuyersreviewed.com/api/auth/",
	dataType : "json",
	headers : {
		"Accept-Language": "bg",
		"Accept" : "json"
	},
	processData: true,
	data : {
		"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB"
	}
	}).done(function( returnedData, textStatus, jqXHRobj ) {
		// response
		console.log(response);
	}).fail(function( jqXHRobj, textStatus, errorThrown ) {
		// error
		console.log(jqXHRobj.responseJSON);
	}
);

 

[PHP CURL]

$request = "?api_key=48ACBAE6-7001-54D5-AADF-BD1019A737DB";
$headers = array(
	"Accept: json",
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.ebuyersreviewed.com/api/auth/'.$request);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, '30');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = trim(curl_exec($ch));
curl_close($ch);

$response = json_decode($response,true);

print_r($response);

 

 

[SCREENING]

Request URL:

https://www.ebuyersreviewed.com/api/screen/

 

request data (JSON):

{
	"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB",
	"name" : "Jorge Escalera",
	"address" : "1280 Saviers Rd Oxnard CA 93033 1732 80 1",
	"email" : "escalerafamily@ymail.com",
	"country" : "US",
	"phone" : "1729"
}

 

NameRequiredTypeDescription
api_key yes string Your eBuyersReviewed authentication key
name yes string Buyer's name
address yes string Buyer's address
email no string Buyer's email address
country yes string Buyer's country code (two characters)
phone no string Buyer's phone number

 

response data (JSON):

{
"data":{
	"message":"",
	"screenings":680,
	"number_results":1,
	"formatted_address":"1280 Saviers Rd Oxnard CA 93033 1732 80 1",
	"results":[{
		"name":"Jorge Escalera",
		"address":"1280 Saviers Rd Oxnard CA 93033 1732 80 1",
		"country_code":"US",
		"country_name":"United States",
		"average_risk_level_value":5,
		"average_risk_level_text":"high",
		"summary":"Jorge Escalera is considered to be a high risk buyer. The buyer has been reported for having misused returns.",
		"suggestion":"Suggestion: Before shipping you may contact this person and explain the terms of your exchange and return policies. You may cancel the order if you feel the buyer can be a serious threat to your reputation and financial performance.",
		"number_reviews":2,
		"date":"Jun 11, 2015",
		"items":[{
			"id":1,
			"name":"Jorge Escalera",
			"address":"1280 Saviers Rd Oxnard CA 93033 1732 80 1",
			"country_code":"US",
			"country_name":"United States",
			"email":"escalerafamily@ymail.com",
			"phone":"1729",
			"title":"Did not return original item",
			"details":"buyer returned a camera he purchased from us 2 years ago.  and he filed disputed against seller. ebay customer services are sucker anyway.",
			"author":"Anonymous",
			"risk_level_value":"5",
			"risk_level_text":"high",
			"summary":"Jorge Escalera is considered to be a high risk buyer. The buyer has been reported for having misused returns.",
			"verified":1,
			"neutral":0,
			"date":"Jun 11, 2015"
		},
		{
			"id":2,
			"name":"Jorge Escalera",
			"address":"1280 Saviers Rd Oxnard CA 93033 1732 80 1",
			"country_code":"US",
			"country_name":"United States",
			"email":"escalerafamily@ymail.com",
			"phone":"1729",
			"title":"Transaction completed.",
			"details":"This buyer has completed a transaction but no review was submitted about him.",
			"author":"Anonymous",
			"risk_level_value":5,
			"risk_level_text":"high",
			"summary":"The assigned risk level for this buyer is neutral.",
			"verified":0,
			"neutral":1,
			"date":"Jun 11, 2015"
			}]
		}]
	}
}

 

Data

NameTypeDescription
message string Administration notifications to user
screenings integer Remaining screening credits of the current eBuyersReviewed account
number_results integer Number of results found based on the search criteria
formatted_address string The address entered upon screening can be changed and standardized. It will show an empty field if it cannot be standardized.
results object array List of all unique reviews. The description is in the next table.

 

Results

NameTypeDescription
name string Buyer's name
address string Buyer's address
country_code string Buyer's two characters short code country code
country_name string Buyer's country
average_risk_level_value integer

Buyer's average risk  level:

0 - neutral
1 - low
2 - low-to-medium
3 - medium
4 - medium-to-high
5 - high 
average_risk_level_text string Buyer's average risk level: "neutral", "low", "low-to-medium", "medium", "medium-to-high", "high"
summary string Summary – a descriptive text of what the buyer did
suggestion string Suggestion on how to proceed with this buyer
number_reviews integer Number of reviews for this buyer
date string Date of last review
items object array Described in the next table

 

Items

NameTypeDescription
Id string Review's ID
name string Buyer's name
address string Buyer's address
country_code string Buyer's country code (two characters)
country_name string Buyer's country
email string Buyer's email address
phone string Buyer's phone number
title string Review's title
details string Review's details
author string Review's author
risk_level_value integer Buyer's average risk level (from 1 to 5)
risk_level_text string Buyer's average risk  level (low, low-to-medium, medium, medium-to-high, high)
summary string Summary – a description of what the buyer being screened did
verified integer If the buyer's address is verified.(1-verified, 0 not verified)
neutral integer

If the buyer doesn't have neither negative nor positive feedback:

"1" - neutral
"0" - has positive or negative feedback
date string Review's date

 
Examples:

Here are two examples of how you can test the API using jQuery or PHP.

 

[jQuery AJAX]

$.ajax({
	type : "GET",
	url : "https://www.ebuyersreviewed.com/api/screen/",
	dataType : "json",
	headers : {
		"Accept-Language": "bg",
		"Accept" : "json"
	},
	processData: true,
	data : {
		"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB",
		"name" : "Jorge Escalera",
		"address" : "1280 Saviers Rd Oxnard CA 93033 1732 80 1",
		"email" : "escalerafamily@ymail.com",
		"country" : "US",
		"phone" : "1729"
	}
	}).done(function( response, textStatus, jqXHRobj ) {
		// response
		console.log(response);
	}).fail(function( jqXHRobj, textStatus, errorThrown ) {
		// error
		console.log(jqXHRobj.responseJSON);
	}
);

 

 

[PHP CURL]

$request = "?api_key=".urlencode('48ACBAE6-7001-54D5-AADF-BD1019A737DB')."&";
$request .= "name=".urlencode('Jorge Escalera')."&";
$request .= "address=".urlencode('1280 Saviers Rd Oxnard CA 93033 1732 80 1')."&";
$request .= "email=".urlencode('escalerafamily@ymail.com')."&";
$request .= "country=".urlencode('US')."&";
$request .= "phone=".urlencode('1729');

$headers = array(
	"Accept: json",
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.ebuyersreviewed.com/api/screen/'.$request);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, '30');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = trim(curl_exec($ch));
curl_close($ch);

$response = json_decode($response,true);

print_r($response);

 

 

[REVIEW A BUYER]

Request URL:

https://www.ebuyersreviewed.com/api/set/

 

request data (JSON):

{
	"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB",
	"name" : "Jorge Escalera",
	"address" : "1280 Saviers Rd Oxnard CA 93033 1732 80 1",
	"country" : "US",
	"email" : "escalerafamily@ymail.com",
	"phone" : "1359",
	"product_category" : "product_category_2",
	"courier" : "courier_0",
	"other_courier" : "",
	"tracking" : "631956046818",
	"risk_level" : 5,
	"summaries" : ["B","C","F"],
	"title" : "Did not return original item",
	"details" : "buyer returned a camera he purchased from us 2 years ago.  and he filed disputed against seller. ebay customer services are sucker anyway.",
	"anonymous" : 1,
	"neutral" : 0,
	"notify_buyer" : 1
}

 

NameRequiredTypeDescription
api_key yes string Your eBuyersReviewed authentication key
name yes string Buyer's name
address yes string Buyer's address
email no string Buyer's email address
country yes string Buyer's country (two characters)
phone no string Buyer's phone number
product_category yes string

Values:

"product_category_0" - Books & Audible
"product_category_1" - Movies, Music & Games
"product_category_2" - Electronics & Computers
"product_category_3" - Home, Garden &Tools
"product_category_4" - Beauty, Health & Grocery
"product_category_5" - Toys, Kids & Baby
"product_category_6" - Clothing, Shoes & Jewelry
"product_category_7" - Sports & Outdoors
"product_category_8" - Automotive & Industrial
"product_category_9" - Art & Collectables
"product_category_10" - Other
courier yes string

Values:

"courier_0" - USPS
"courier_1" - UPS
"courier_2" - FedEx
"courier_3" - FedEx Ground
"courier_4" - FedEx SmartPost
"courier_5" - DHL
"courier_6" - DHL Global Mail
"courier_7" - UPS Mail Innovations
"courier_8" - OSM
"courier_9" - OnTrac
"courier_10" - Streamlite
"courier_11" - Newgistics
"courier_12" - Blue Package
"courier_13" - Canada Post
"courier_14" - Other (specify)
"courier_15" - Not Applicable
other_courier yes string Other courier
tracking Yes string Tracking number
risk_level Yes integer

Values:

"0" - neutral
"1" - low
"2" - low-to-medium
"3" - medium
"4" - medium-to-high
"5" - high
summaries Yes array

Values:

"A" - made unreasonable demands
"B" - gave unfair negative feedback
"C" - misused returns
"D" - mistakenly bought the wrong item (wrong size)
"E" - cancelled an order for no reason
"F" - provided wrong shipping address / was unreachable for delivery
"G" - other problems
"H" - no problems whatsoever
title Yes string Review's title
details No string Review's details
anonymous Yes integer

Values:

"0" - review author 's name is visible
"1" - review author's name is hidden
neutral No integer

Values:

"0" - the review is not neutral
"1" - the review is neutral
Default: 0
notify_buyer Yes integer

Values:

"0" - The API will not send an email to the buyer
"1" - The API will send an email to the buyer

 

response data (JSON):

{
	"error":""
}

 

NameDescription
error Error message


Examples:

Following are two examples of how you can test the API using jQuery or PHP:

 

[jQuery AJAX]

$.ajax({
	type : 'POST',
	url : "https://www.ebuyersreviewed.com/api/set/",
	dataType : "json",
	headers : {
		"Accept-Language" : "bg",
		"Accept" : "json"
	},
	processData: true,
	data : {
		"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB",
		"name" : "Jorge Escalera",
		"address" : "1280 Saviers Rd Oxnard CA 93033 1732 80 1",
		"country" : "US",
		"email" : "escalerafamily@ymail.com",
		"phone" : "1359",
		"product_category" : "product_category_2",
		"courier" : "courier_0",
		"other_courier" : "",
		"tracking" : "631956046818",
		"risk_level" : 5,
		"summaries" : ["B","C","F"],
		"title" : "Did not return original item",
		"details" : "buyer returned a camera he purchased from us 2 years ago.  and he filed disputed against seller. ebay customer services are sucker anyway.",
		"anonymous" : 1,
		"neutral" : 0,
		"notify_buyer" : 0,
	}
	}).done(function( response, textStatus, jqXHRobj ) {
		// response
		console.log(response);
	}).fail(function( jqXHRobj, textStatus, errorThrown ) {
		// error
		console.log(jqXHRobj.responseJSON);
	}
);

 

 

[PHP CURL]

$headers = array(
	"Accept: json",
);

$postFields = array(
	"data" : json_encode(array(
		"api_key" : "48ACBAE6-7001-54D5-AADF-BD1019A737DB",
		"name" : "Jorge Escalera Eib",
		"address" : "1280 Saviers Rd Oxnard CA 93033 1732 80 1",
		"country" : "US",
		"email" : "escalerafamily@ymail.com",
		"phone" : "1359",
		"product_category" : "product_category_2",
		"courier" : "courier_0",
		"other_courier" : "",
		"tracking" : "63195604682318",
		"risk_level" : 5,
		"summaries" : array("B","C","F"),
		"title" : "Did not return original item",
		"details" : "buyer returned a camera he purchased from us 2 years ago and he filed disputed against seller. ebay customer services are sucker anyway.",
		"anonymous" : 1,
		"neutral" : 0,
		"notify_buyer" : 0,
	))
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.ebuyersreviewed.com/api/set/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, '30');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);
$response = trim(curl_exec($ch));
curl_close($ch);

$response = json_decode($response,true);

print_r($response);

 

 

To use either one or both integration methods, you need to have registered with eBuyersReviewed.com. Click here to sign up.

What Our Clients Say About Us

  • "eBuyersReviewed is a tool our company cannot live without.  Screening buyers has become an essential part of our order processing.  Arguably one of the best seller tools to come out in the past 10 years."

    Wendy D., eBay Seller

  • "I specifically like the zip code alert feature, which helped me with a sale just recently. The system alerted me on a buyer living in a high-risk area, so I called her to see which delivery option would be best."

    Tim K., Online Seller

  • "Our company now has a more complete profile of our customers and can better handle customer service issues.  I have been waiting for such a service for years"

    Carla M., eCrater Seller

  • "So happy to finally be able to report bad buyers to someone that cares and is doing something about buyer fraud.  Awesome service - thanks for looking out for sellers."

    Fred S., Amazon Seller

  • "The customer wanted to cancel his order after I had already shipped it. I immediately reviewed him on eBuyersReviewed as a bad buyer and had a notification sent to him."

    Sonya T., Online Seller

  • "eBuyersReviewed is without a doubt the best thing ever, before I found them I'd been looking around for ages for a way to protect my ecommerce store."

    Amanda S., eBay Seller

  • "I was really happy putting in my reviews of buyers anonymously. It’s nice to be able to use a website that helps you with your selling business."

    Scott M., eBay Seller

  • "The buyer was trying to get an extra discount on something he had already received and threatened leaving negative feedback. I told him that I will also leave him negative feedback on eBuyersReviewed."

    Amy B., Online Seller

  • "Due to your company sending a notification to my customer, we were able to resolve the issue we had with him. Thank you!!! This is why your site is so important to merchants. Thanks again!!!!!!"

    Sara C., Online Seller

  • "eBuyersReviewed is a great tool - helping me save money at the end of the month."

    Jeremy B., eBay Seller

eBuyers Reviewed
Home Review a Buyer Screen a Buyer My Buyer Rating Integration Tools Message Board
About Us
About Us Contact Us Testimonials Q&A Seller Tips
Account
Log In Sign Up
Connect With Us
Find us in Facebook Find us in Twitter Find us in Google plus Find us in Youtube
© 2020 Ebuyers Reviewed, All Rights Reserved.
Privacy Policy Terms of Service