Documentation du plugin

Voir les catégories

Développeurs : Extraits de code et ressources

3 min lire

Nous ne disposons pas actuellement d'une documentation approfondie pour les développeurs, mais voici quelques extraits de code et ressources utiles pour les développeurs.

Tables de la base de données

Le plugin possède ses propres tables de base de données à partir desquelles vous pouvez obtenir certaines données :

wcusage_activity - Journal d'activité.

wcusage_campaigns - Campagnes d'URL de référence.

wcusage_clicks - Journal des clics de l'URL de référence.

wcusage_directlinks - Domaines de suivi des liens directs.

wcusage_mlainvites - Invitations d'affiliés multi-niveaux.

wcusage_payouts - Paiement des commissions

wcusage_register - Applications d'enregistrement des affiliés.

Commandes des affiliés

Obtenir toutes les commandes d'affiliés pour un coupon, sans certaines plages de données. Cette fonction renvoie un tableau de données comprenant le total des calculs pour toutes les commandes et toutes les commandes individuelles.

$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 ) ;

Données de commande

Cette fonction vous permet d'obtenir un tableau de données relatives à l'affiliation pour une certaine commande. Cette fonction renvoie un tableau de données comprenant les revenus de la commission.

$order_data = wcusage_calculate_order_data( $order_id, $coupon_code, 0, 1 ) ;

Pour obtenir la commission de la commande, par exemple :

$commission = $order_data['totalcommission'] ;

URL de l'affilié

La fonction suivante permet d'obtenir l'URL d'affiliation d'un coupon :

$coupon_code = "" ; // Définissez ici le nom du code du coupon.
$affiliate_url = wcusage_get_affiliate_url($coupon_code) ;

Si vous souhaitez créer votre propre URL, voici un exemple :

$coupon_code = "" ; // Définissez ici le nom du code du coupon.
$prefix = wcusage_get_setting_value('wcusage_field_urls_prefix', 'coupon') ;
$affiliate_url = get_home_url() . " ?" . $prefix . "=" . $coupon_code ;

Total des ventes et des commissions

Obtenez le total des ventes et des commissions gagnées par un certain coupon, sans une certaine plage de dates. Laissez $start_date vide pour obtenir toutes les ventes.

$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 ) ;
$total_orders = $orders['total_orders'] ; // Total des ventes
$total_discounts = $orders['full_discount'] ; // Total des remises
$total_commission = $orders['total_commission'] ; // Commission totale
$order_count = $orders['total_count'] ; // Nombre de commandes

Commission non rémunérée

Obtenir la commission totale non payée pour un coupon d'affilié.

$coupon_id = "" ; // Définissez ici l'ID du code du coupon.
$unpaid_commission = get_post_meta( $coupon_id, 'wcu_text_unpaid_commission', true ) ;

Crochet (Action) : Enregistrement d'un nouvel affilié

Lorsqu'il y a une nouvelle inscription d'affilié, il lance le hook "wcusage_hook_registration_new" qui transmet l'ID de l'inscription, l'ID de l'utilisateur et le code du coupon.

Vous pouvez donc appeler ce crochet pour accepter automatiquement l'enregistrement sous certaines conditions avec la fonction "wcusage_set_registration_status". Par exemple, cette fonction acceptera automatiquement l'enregistrement si le rôle de l'utilisateur est "exemple" :

add_action('wcusage_hook_registration_new', 'trigger_wcusage_hook_registration_new', 10, 3 ) ;
function trigger_wcusage_hook_registration_new( $registration_id, $user_id, $coupon_code ) {
    $user_info = get_userdata( $user_id ) ;
    $roles = $user_info->roles ;

    if ( in_array( 'example', $roles ) ) {
        wcusage_set_registration_status( 'accepted', $registration_id, $user_id, $coupon_code, '', '' ) ;
    }
}

Crochet (Action) : Nouvel affilié accepté

Lorsqu'un nouvel affilié est accepté et ajouté à votre programme, il exécute le "wcusage_hook_affiliate_register_accepted" qui transmet les éléments suivants :

  • $id - ID d'enregistrement.
  • $userid - Identifiant de l'utilisateur.
  • $coupon_code - Code Coupon.
  • $message - Le message d'acceptation de l'enregistrement.
  • $status - Le statut de leur enregistrement.
add_action( 'wcusage_hook_affiliate_register_accepted', 'trigger_wcusage_hook_registration_accepted', 10, 5 ) ;
function trigger_wcusage_hook_registration_accepted( $id, $userid, $coupon_code, $message, $status ) {
// Votre code ici.
}

Point final API : Informations sur les coupons

Le Informations sur les coupons vous permet de récupérer les détails d'un coupon spécifique à l'aide de son ID. Cela inclut le nom du coupon, la commission non payée et les paiements en attente, ce qui en fait un outil essentiel pour suivre les performances des coupons et le statut des paiements. Seuls les administrateurs peuvent accéder à ce point de terminaison.

Pour utiliser l'API, envoyez un GET demande à /wp-json/woo-coupon-usage/v1/coupon-info avec le paramètre requis coupon_id (l'identifiant du coupon que vous souhaitez interroger). La réponse comprendra un tableau contenant les nom_du_coupon, commission_non_rémunéréeet paiements en attente.

Point final de l'API : Coupons d'utilisateurs

Le Coupons de l'utilisateur vous permet de récupérer une liste d'identifiants de coupons attribués à un utilisateur spécifique, ainsi que la commission non payée qui leur est associée. Cette fonctionnalité est utile pour contrôler et gérer les attributions de coupons et les commissions propres à un utilisateur. L'accès à ce point de terminaison est limité aux administrateurs.

Pour utiliser l'API, envoyez un GET demande à /wp-json/woo-coupon-usage/v1/users-coupons avec le paramètre requis utilisateur (le nom de connexion de l'utilisateur dont vous souhaitez récupérer les coupons). L'API renvoie un tableau d'identifiants de coupons avec leur commission non payée, ce qui permet d'avoir une vue d'ensemble de l'activité de l'utilisateur en matière de coupons.

Point final API : Demande de paiement

Le Demande de paiement Ce point de terminaison de l'API vous permet de déclencher des demandes de paiement pour un coupon spécifique. Il vérifie l'utilisateur qui demande le paiement et vérifie si la commission non payée du coupon est valide et prête à être traitée.

Pour utiliser l'API, créez un POST demande à /wp-json/woo-coupon-usage/v1/request-payout avec deux paramètres obligatoires : coupon_id (l'ID du coupon) et utilisateur (le nom de connexion de l'utilisateur qui demande le paiement). Assurez-vous que l'utilisateur qui appelle a des droits d'administrateur. Si la validation est réussie, le système traite la demande de paiement et renvoie les informations suivantes 1 pour réussir ou 0 de l'échec.

—

Vous avez besoin d'aide pour une fonction personnalisée ? N'hésitez pas à nous contacter et nous pourrons peut-être vous orienter dans la bonne direction.

Quels sont vos sentiments ?