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
Single sign on
Generates a single sign on token for a subaccount.Base URL
POST: https://api4coupons.com/v3/subaccount/sso
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 | subaccount | ID of the subaccount | Numeric only. Can be found in the list of your subaccounts. |
Required
|
| 4 | page | page to load after login | Available options: campaigns, add_campaign, update_campaign, statistics, distribution. |
Optional
|
| 5 | campaign | ID of the campaign | Only required when you use the page=update_campaign option. |
Optional
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/subaccount/sso"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'subaccount' => "sub_1234" ]; 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 success response
{
"status": {
"status": "OK"
},
"subaccount": {
"ID": "sub_12345",
"token": "Nu5oAs7QDdCPLN7mkFUAQzPp66JJ8wwDCUd312GeFvZrDlLhf",
"url": "https://www.controlpanel.center/index.php?action=login&logintype=sso&token=Nu5oAs7QDdCPLN7mkFUAQzPp66JJ8wwDCUd312GeFvZrDlLhf",
"url_whitelabel": "https://login.yourdomain.com/index.php?action=login&logintype=sso&token=Nu5oAs7QDdCPLN7mkFUAQzPp66JJ8wwDCUd312GeFvZrDlLhf"
}
}
Example error response
{
"status": {
"status": "failed",
"errors": {
"error_message": "HTTP/1.0 422 Unprocessable entity.",
"error_message_description": [
"Invalid character in parameter: subaccount."
],
"error_code": [
301
]
}
}
}
Possible errors
- 200: Missing parameter: subaccount
- 510: Subaccount ID not correct.