API Documentation
You can use these APIs to pull reviews and other data for internal or external purposes. If you will display your reviews externally, you must credit Donor Approved next to the reviews.
The Donor Approved API allows you to get and change some details without the need to login to Donor Approved. The API is meant for server-side calls only and should not be used for AJAX calls.
Note that use of the API requires programming knowledge.
General Information (GET)
API Code
JSON:
https://www.donorapproved.com/api/sites/?siteid=56470&token=dh98ab5670
XML:
https://www.donorapproved.com/api/xml/sites/?siteid=56470&token=dh98ab5670
The following information will be returned in the format you chose (xml / json):
site:
Yoursite.org
url:
siteid:
56470
review_count:
average:
Get Reviews (GET)
Optional Parameters
from:
to:
sort:
page:
API Code:
JSON:
https://www.donorapproved.com/api/reviews/?siteid=56470&token=dh98ab5670=2019-01-01&to=2019-02-01&sort=newest&page=0
XML:
https://www.donorapproved.com/api/xml/reviews/?siteid=56470&token=dh98ab5670=2019-01-01&to=2019-02-01&sort=newest&page=0
A list with the following information will be returned in the format you chose (xml / json):
Name:
The Donor Name
displaydate:
textcomments:
The comments made by the donor
fullurl:
overall:
recommend:
Get Reviews by Order ID (GET)
Required Parameters
orderid:
API Code:
JSON:
https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670=012563
XML:
https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670=756
A list with the following information will be returned in the format you chose (xml / json):
Name:
The Donor Name
displaydate:
textcomments:
The comments made by the donor
fullurl:
overall:
recommend:
Cancel Review (POST)
Required Parameters
orderid:
reviewid:
cancel:
API Code:
JSON:
https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670=48563
XML:
https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670&cancel=1&orderid=456
Move up follow-up survey email. (POST)
Required Parameters
orderid:
reviewid:
shipped:
date:
API Code:
JSON:
https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670&orderid=45863
XML:
https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670&cancel=1&orderid=453
Note that use of the API requires programming knowledge.
Get Reviews (GET)
Optional Parameters
from:
to:
sort:
page:
API Code:
JSON:
https://www.donorapproved.com/api/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2014-02-01&sort=newest&page=0
XML:
https://www.donorapproved.com/api/xml/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2014-02-01&sort=newest&page=0
A list with the following information will be returned in the format you chose (xml / json):
Name:
The Donor Name
location:
The Donor Location (if available)
displaydate:
textcomments:
The comments made by the donor
fullurl:
overall:
productId:
public:
Get Review By Product ID (GET)
Required Parameters
productid:
Optional Parameters
to:
sort:
page:
API Code:
JSON:
https://www.donorapproved.com/api/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2019-02-01&sort=newest&page=0
XML:
https://www.donorapproved.com/api/xml/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2019-02-01&sort=newest&page=0
A list with the following information will be returned in the format you chose (xml / json):
Name:
The Donor Name
location:
The Donor Location (if available)
displaydate:
textcomments:
The comments made by the donor
fullurl:
overall:
productId:
public:
Get Aggregate Information (GET)
Optional Parameters
productid:
to:
sort:
page:
API Code:
JSON:
https://www.donorapproved.com/api/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2019-02-01&sort=newest&page=0
XML:
https://www.donorapproved.com/api/xml/reviews/?siteid=56470&token=ad42af4095&from=2019-03-01&to=2019-02-01&sort=newest&page=0