{"id":25758,"date":"2023-09-26T15:04:16","date_gmt":"2023-09-26T15:04:16","guid":{"rendered":"https:\/\/couponaffiliates.com\/docs\/developers\/"},"modified":"2023-09-26T15:04:16","modified_gmt":"2023-09-26T15:04:16","slug":"desarrolladores","status":"publish","type":"aisa_doc","link":"https:\/\/couponaffiliates.com\/es\/docs\/developers\/","title":{"rendered":"Desarrolladores: Fragmentos de c\u00f3digo y recursos"},"content":{"rendered":"\n

The REST API is wcusage\/v2<\/code>. Enable it under Coupon Affiliates > Admin Tools > API<\/strong>, then see API & Webhooks<\/a> for merchant setup (keys, scopes, webhooks) and the API documentation<\/a> for authentication, routes, payloads and examples.<\/p>\n\n\n\n

Below are PHP snippets and resources that customers have asked for. They are not a substitute for the REST API reference.<\/p>\n\n\n\n

Database Tables<\/h2>\n\n\n\n

The plugin does have its own database tables that you can get certain data from:<\/p>\n\n\n\n

wcusage_activity – Activity log.<\/p>\n\n\n\n

wcusage_api_keys – REST API keys (hashed), with their scopes, status and last-used date.<\/p>\n\n\n\n

wcusage_campaigns – Referral URL campaigns.<\/p>\n\n\n\n

wcusage_clicks – Referral URL clicks log.<\/p>\n\n\n\n

wcusage_directlinks – Direct link tracking domains.<\/p>\n\n\n\n

wcusage_mlainvites – Multi-Level affiliates invites.<\/p>\n\n\n\n

wcusage_payouts – Commission Payouts<\/p>\n\n\n\n

wcusage_register – Affiliate registration applications.<\/p>\n\n\n\n

wcusage_rewards_log – Log of performance bonuses (rewards) earned by affiliates, including the reward name, requirement met and bonuses granted.<\/p>\n\n\n\n

Webhooks are not stored in a table; they are saved in the wcusage_api_webhooks<\/code> option.<\/p>\n\n\n\n

Affiliate Orders<\/h2>\n\n\n\n

Get all affiliate orders for a coupon, without certain data range. This returns an array of data including the total calculations for all the orders, and all the individual orders.<\/p>\n\n\n\n

$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 );<\/code><\/pre>\n\n\n\n
Order Data<\/h2>\n\n\n\n
You can get an array of affiliate related data for a certain order via this function. This returns an array of data including the commission earnings.<\/p>\n\n\n\n
$order_data = wcusage_calculate_order_data( $order_id, $coupon_code, 0, 1 );<\/code><\/pre>\n\n\n\n
To get the commission from the order for example:<\/p>\n\n\n\n
$commission = $order_data['totalcommission'];<\/code><\/pre>\n\n\n\n
Affiliate URL<\/h2>\n\n\n\n
Get the affiliate URL for a coupon via the following function:<\/p>\n\n\n\n
$coupon_code = ""; \/\/ Set the coupon code name here.\n$affiliate_url = wcusage_get_affiliate_url($coupon_code);<\/code><\/pre>\n\n\n\n
Or if you want to build your own custom URL here’s an example:<\/p>\n\n\n\n
$coupon_code = ""; \/\/ Set the coupon code name here.\n$prefix = wcusage_get_setting_value('wcusage_field_urls_prefix', 'coupon');\n$affiliate_url = get_home_url() . "?" . $prefix . "=" . $coupon_code;<\/code><\/pre>\n\n\n\n
Total Sales and Commission<\/h2>\n\n\n\n
Get the total sales and commission earned by a certain coupon, without a certain date range. Leave $start_date empty to get all sales.<\/em><\/p>\n\n\n\n
$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 );\n$total_orders = $orders['total_orders']; \/\/ Total Sales\n$total_discounts = $orders['full_discount']; \/\/ Total Discounts\n$total_commission = $orders['total_commission']; \/\/ Total Commission\n$order_count = $orders['total_count']; \/\/ Orders Count<\/code><\/pre>\n\n\n\n
Unpaid Commission<\/h2>\n\n\n\n
Get the total unpaid commission for an affiliate coupon.<\/p>\n\n\n\n
$coupon_id = ""; \/\/ Set the coupon code ID here.\n$unpaid_commission = get_post_meta( $coupon_id, 'wcu_text_unpaid_commission', true );<\/code><\/pre>\n\n\n\n
Hook (Action): New Affiliate Registration Submitted<\/h2>\n\n\n\n
When there is a new affiliate registration, it will run the “wcusage_hook_registration_new” hook that will pass the registration ID, user ID, and coupon code.<\/p>\n\n\n\n
You could therefore call this hook to automatically accept the registration under certain conditions with the “wcusage_set_registration_status” function. For example this will automatically accept the registration if the users role is “example”:<\/p>\n\n\n\n
add_action( 'wcusage_hook_registration_new', 'trigger_wcusage_hook_registration_new', 10, 3 );\nfunction trigger_wcusage_hook_registration_new( $registration_id, $user_id, $coupon_code ) {\n    $user_info = get_userdata( $user_id );\n    $roles = $user_info->roles;\n\n    if ( in_array( 'example', $roles ) ) {\n        wcusage_set_registration_status( 'accepted', $registration_id, $user_id, $coupon_code, '', '' );\n    }\n}<\/code><\/pre>\n\n\n\n
Hook (Action): New Affiliate Accepted<\/h2>\n\n\n\n
When a new affiliate is accepted and added to your program, it will run the “wcusage_hook_affiliate_register_accepted” that will pass the following:<\/p>\n\n\n\n