Shoffi Docs
  • 👋Getting Started
  • 💻For App Owners
    • Adding a new app
    • Google Analytics integration
    • The affiliate terms
    • Managing affiliates
    • Invite affiliates
    • Paying affiliates
    • Managing your apps
    • Managing your team
    • Integrations (Webhooks)
  • 💳Subscriptions
    • Choosing/Upgrading a plan
    • Plan limits
    • Changing billing details
    • Downgrade and cancellation
    • Frozen and Deactivated accounts
  • 🔀The Shoffi API
    • Introduction to Shoffi API
    • Get All Affiliates
    • Get Affiliate Info
    • Create New Affiliate
    • Update Affiliate Terms
    • Affiliate Payment Request
  • 🔗For Affiliates
    • Connecting to new apps
    • Referral links
    • Manual referrals
    • Payout requests
    • Performance analytics
    • Connected app Information
  • General
    • The markets
    • The affiliate commision
    • Disputes
Powered by GitBook
On this page
  • Get all the information about a specific affiliates
  • Response example
  1. The Shoffi API

Get Affiliate Info

Get all the information about a specific affiliates

GET https://platform.shoffi.app/API/affiliate/getInfo

Request Body

Name
Type
Description

apiKey*

String

Your Shoffi app API Key

appId*

Integer

Your app ID

email*

String

The affiliate email address

{
    "affiliateDetails": {
        "email": "[email protected]",
        "firstName": "Tobias",
        "lastName": "Lütke",
        "nickName": "tobi"
    },
    "affiliateTerms": {
        "revenueShare": 30,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50
    },
    "affiliatePerformance": {
        "appProfit": 1000,
        "affiliateProfit": 300,
        "paidToAffiliate": 100,
        "linkViews": 72
    },
    "affiliateLink": "https://platform.shoffi.app/r/rl_xxxxxxxx",
    "referralCount": 10
}
{
    "status": 400,
    "message": "Error details"
}
curl -X POST \
  https://platform.shoffi.app/API/affiliate/getAll \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "email": "[email protected]"
  }'

Response example

200 OK
Content-Type: application/json
{
    "affiliateDetails": {
        "email": "[email protected]",
        "firstName": "Tobias",
        "lastName": "Lütke",
        "nickName": "tobi"
    },
    "affiliateTerms": {
        "revenueShare": 30,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50,
        "recurringChargeOnly": true
    },
    "affiliatePerformance": {
        "appProfit": 1000,
        "affiliateProfit": 300,
        "paidToAffiliate": 100,
        "linkViews": 72
    },
    "affiliateLink": "https://platform.shoffi.app/r/rl_xxxxxxxx",
    "referralCount": 10
}
PreviousGet All AffiliatesNextCreate New Affiliate

Last updated 1 year ago

🔀