API & Webhooks
Connect the Coupontools platform with your apps or web projects. The Coupontools REST API allows you to query meta-data about your account, campaigns, distribution, validations, and usage data.
-
Subaccount
- Retrieve a list of subaccounts
- Retrieve info of a subaccount
- Create a subaccount
- Update a subaccount
- Create password reset url for subaccount
- Single sign on for subaccounts
-
Campaign
- Retrieve a list of your campaigns
- Retrieve information from a campaign
- Retrieve all usage data from a campaign
- Retrieve all data from one coupon session
- Update data from a coupon session
- Update data from multiple coupon sessions
- Search coupon session
- Search coupon session from a campaign
- Send single push notification
- Send push notification to all
-
Loyalty Card
- Retrieve a list of your loyalty cards
- Retrieve a list of users from a loyalty card
- Update loyalty card user
- Send single push notification
- Send push notification to all
-
Directory
- Retrieve a list of your directories
- Retrieve information from a directory
- Retrieve all campaigns from a directory
- Retrieve registered users from a directory
- Update directory user payment status
- Retrieve a list of categories
- Retrieve a list of 3rd level categories
-
Single Use
- Create a single use access URL
- Create multiple single use access URLs
- Remove a single use access URL
Retrieve information from a campaign
Returns information of one specific campaign.Base URL
POST: https://api4coupons.com/v3/coupon/info
Parameters
# | Parameter | Input | Description | |
---|---|---|---|---|
1 | client_id | API client ID | Can be found in your API documentation | Required |
2 | client_secret | API client secret | Can be found in your API documentation | Required |
3 | campaign | ID from the campaign | Can be found in the list of all campaigns. Example: cam_12345 |
Required
|
4 | show_usage_stats | true or false | Defaults to false, will add the total numer of custom validation codes en number of claimed custom codes |
Optional
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/coupon/info"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'campaign' => "cam_123456" ]; curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); ?>
Example response
{ "status": { "status": "OK" }, "coupon_info": { "ID": "cam_123456", "code": "abc123", "url": "https://digicpn.com/p/abc123", "status": "example", "subaccount": "", "name": "[NO NAME]", "title": "10% OFF", "subtitle": "On all pizzas", "description": "", "expirydate": "2018-08-12 11:19:00", "timezone": "UTC", "terms": "", "terms_short": "Example coupon;", "poweredby": "Your Company", "poweredbylink": "http://www.yourwebsite.com", "coupon_tags": "", "coupon_category": "1", "coupon_category_name": "", "logo_url": "https://hosting4images.com/upload/logo/302_logo_170518101046.jpg", "banner1": "https://www.hosting4images.com/preview/image.jpg", "banner2": "https://www.hosting4images.com/preview/image.jpg", "banner3": "https://www.hosting4images.com/preview/image.jpg", "banner4": "https://www.hosting4images.com/preview/image.jpg", "banner5": "https://www.hosting4images.com/preview/image.jpg", "coupon_image": "https://hosting4images.com/upload/customimage/image.jpg", "locations": [ { "ID": "loc_12345", "company_name": "location", "company_email": "info@location.com", "company_phone": "", "company_password": "123456789", "company_street": "", "company_zip": "", "company_city": "", "company_state": "", "company_country": "", "company_lat": "0.000000", "company_long": "0.000000", "company_hours": "" } ], "amount": 20, (only calculated when show_usage_stats is true) "amount_claimed": 5, (only calculated when show_usage_stats is true) "amount_validated": 4, (only calculated when show_usage_stats is true) (following three are only shown when the campaign is configured to generate codes) "code_prefix": "ab_3_", "code_length": "20", "code_type": "numeric" } }
Possible errors
- 200: Missing parameter: campaign
- 301: Invalid character in parameter: campaign.
- 502: Campaign ID not found.