Developers
Getting Started
Click here for a step-by-step developer guide to using our APIs. Each stakeholder group is represented, and the instructions include all necessary steps for connecting and managing AI (8112) offers.
Platform Documentation
Here you will find comprehensive guides and documentation to help you start working with TCB, as well as support should you have any questions or issues.
API Documentation
Here you will find step-by-step API documentation and testing sandbox for developers.
Try The TCB Platform
Jump right into our development portal! As a new user, you can initially proceed with test data and then when you are ready to go live, we will push your account to the production server without any added test data for a clean start.
Manufacturer API Example
Create Master Offer File
curl -X POST 'https://try.thecouponbureau.org/manufacturer/base_gs1' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN' \
--data '{
"data":{
"base_gs1":"8112010031493140188",
"brand_id":"XYZ",
...
}
}
Authorized Partner API Example
Get connected manufacturer
curl -X GET 'https://try.thecouponbureau.org/manufacturer_agent/manufacturers' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN'
Provider API Example
Get authorized master offer files
curl -X GET 'https://try.thecouponbureau.org/provider/base_gs1s' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN'
Accelerator API Example
Get Connected Retailers
curl -X GET 'https://try.thecouponbureau.org/accelerator/retailers' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN'
Retailer API Example
Redeem a Coupon
curl -X POST 'https://try.thecouponbureau.org/retailer/redeem' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN' \
--data '{
"gs1s":"<Comma seperated GS1s>",
"selected_store":"<Store ID>"
}'
Clearinghouse API Example
Get Authorized Retailers
curl -X GET 'https://try.thecouponbureau.org/clearinghouse/retailers' \
-H 'Content-Type: application/json' \
-H 'x-access-key: ACCESS_KEY' \
-H 'x-access-token: ACCESS_TOKEN'