Integration Overview
Overview
SoyCap.io enables merchants to run Web3 affiliate campaigns with rewards in USDC on the Solana blockchain, ensuring fast, secure and middle-man free transactions between your business and affiliates.
Merchants can integrate SoyCap.io in a few simple steps:
-
Obtain Merchant API Key
Log in to your SoyCap.io dashboard to retrieve a merchant API key, which is required for API access.
-
Authenticate Merchant
Log in to your SoyCap.io dashboard to retrieve a merchant API key, which is required for API access.
-
Implement Affiliate Tracking Attribution
When users arrive at your campaign landing page capture an unique
sc-ref-id
referral id from the query string of the referral URLs shared by your affiliates. Store it in a session, cookie or database for later conversion tracking. You can also usesc-cmp-id
query string parameter to monitor visitors traffic generated by each affiliate campaign using Google Analitycs or any other traffic monitoring tool. -
Obtain Campaign(s) Keypair
To register conversions and distribute USDC payouts for a specific campaign you will need to sign web3 transactions using the same keypair that was used for affiliate campaign creation. The campaign public key (or campaign owner) is displayed on the SoyCap.io dashboard. Learn how to generate your keypair from Phantom wallet secret phrase here.
-
Register Conversion
Once user has performed some conversion event on your site (ordering a product, subscribing to service, etc.) you can register a new SoyCap.io conversion using user’s
sc-ref-id
referral id, campaign keypair and standard@solana/web3.js
library. -
Update Conversion Metadata (Optional)
You can add additional conversion metadata to each registered conversion. For example you can track Conversion Business Value to calculate precise campaign performance.
-
Distribute Reward
Once conversion is registered you can immediately distribute affiliate reward (make a payout) or use one of the scheduling techniques for automatic rewards distribution.
-
Schedule Rewards Distribution
Once conversion is registered you can immediately distribute affiliate reward (make a payout) or use one of the scheduling techniques for automatic rewards distribution.
Refer to the Quick Start Guide for detailed steps.