Skip to content

appvirality/AppVirality-API

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits

README.md

README.md

 
 

Repository files navigation

(Deprecated) AppVirality-API

IMP: API V1.0 has been deprecated, Please use latest API V2.0 http://dev.appvirality.com/docs/appvirality-docs/appvirality-api/

AppVirality provides API feature to pull the reward details and redeem the rewards. AppVirality shall take care of reward distribution in case if the reward type is coupons (provided coupon availability in AppVirality dashboard), other than coupon case (i.e In-store Credits or Other) App owner has to take care of reward distribution and in such cases AppVirality shall provide the reward details and available balance for each referrer/friend.

AppVirality API is accessed via the https://api.appvirality.com domain.

NOTE: All dates provided in API calls are in UTC±00 Time zone.

INDEX

  1. Get Referrer Rewards

  2. Get Friend Rewards

  3. Redeem Referrer Rewards

  4. [Change Reward Status] (https://github.com/appvirality/AppVirality-API#4-change-reward-status)

  5. [Redeem Friend Rewards] (https://github.com/appvirality/AppVirality-API#5-redeem-friend-rewards)

  6. [Get Referrer/Friend Balance] (https://github.com/appvirality/AppVirality-API#6-get-referrerfriend-balance)

  7. [Register Conversion Event] (https://github.com/appvirality/AppVirality-API#7-register-conversion-event)

  8. [Update User details] (https://github.com/appvirality/AppVirality-API#8-update-user-details)

  9. [Approve Dynamic Coupon] (https://github.com/appvirality/AppVirality-API#9-approve-dynamic-coupon)

  10. [Check Reward Status] (https://github.com/appvirality/AppVirality-API#10-check-reward-status)

  11. [Get AppUser Details] (https://github.com/appvirality/AppVirality-API#11-get-appuser-details)

  12. [Get Campaign] (https://github.com/appvirality/AppVirality-API#12-get-campaign)

  13. [Add Test Device] (https://github.com/appvirality/AppVirality-API#13-add-test-device)

  14. [Reset Test Device] (https://github.com/appvirality/AppVirality-API#14-reset-test-device)

  15. Get Referrer Rewards

Get the list of Referrer rewards

Route

POST /v1/getreferrerrewards

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • pagenum — Number of the Page. 50 records per page.
  • fromdate — Start date. Date format should be d-MMM-yyyy H:m, Timezone UTC±00 (Eg. 2-Feb-2015 2:13).
  • todate — End date to filter rewards (Eg. 2-Feb-2015 14:3).
  • status — This can be used to filter the Rewards. You can use "EligibleForReward" / "Rewarded" / "All" / "Suspicious" / "Rejected" / "Approved" / "UnderReview".

Status:

UnderReview — Rewards which does not met the review period.

EligibleForReward — Referrers list with Approved Rewards (i.e met with review period and redemption cap).

Rewarded — Rewards which are dispatched i.e. with the status "Rewarded".

Suspicious — Rewards marked as Suspicious i.e detected by fraud detection system.

Rejected — Rejected rewards i.e Suspicious rewards can be rejected.

Approved — Rewards Approved but not yet Rewarded.

All — Rewards with all the above status.

#####Sample Input:

{
"apikey":"763502957c434314b613d42400ac7a7f",
"privatekey":"8a433343ee8241a10419212415496579",
"pagenum":"1",
"fromdate":null,
"todate":"2-Feb-2015 2:13",
"status":"EligibleForReward"
}

#####Response Parameters:

  • participantid — Campaign Participant ID
  • emailid — Email of the Referrer
  • name — Name of the Referrer
  • userkey — Unique key to identify App User
  • storeuserid — This is the ID with which you recognize the user uniquely in your store.
  • campaignid — Unique Campaign ID
  • campaignname — Name of the Campaign
  • rewardid — Reward ID, to Track the Reward and Distribution
  • reward_type — Type of Reward (Coupon, InstoreCredits,Other)
  • rewarded_date — Reward Initiated Date
  • amount — amount of money to reward (null when non-monetary incentive is used)
  • reward_unit — Currency Unit of the Reward
  • couponcode — Coupon code dispatched to Referrer, as a reward. Only when the Reward type is coupon.
  • expires — Coupon expiry date.
  • rewarddetails — Rewards break down
    • rewarddtlid — Reward detail ID
    • amount — amount of money to reward (null when non-monetary incentive is used)
    • rewarded_date — Reward Initiated Date
    • status — Status mentioned in the Query
    • eventname — Install, Signup, Transaction & Any defined Custom Events
    • friendEmail — Friend Email
    • friendStoreId — This is unique store user ID of friend
    • extrainfo — Info provided during the Conversion Event. Data will be Uri encoded.
    • status — Status of the reward.
  • totalrecords — The total number of records(individual rewards) available in the given date time range.

#####Sample Response:

{
	"rewards": [{
		"participantid": "93700",
		"emailid": "refr4@gmail.com",
		"name": "refr4name",
		"userkey": "a4953b1e65744732b999d1af1815bf7e",
		"storeuserid": null,
		"campaignid": "216",
		"campaignname": "MySample",
		"eventname": null,
		"rewardid": "3325",
		"reward_type": "Coupon",
		"rewarded_date": "2-Mar-2015 0:2:29",
		"status": "All",
		"amount": "20",
		"reward_unit": "%24",
		"couponcode": "REFERRER10",
		"expires": "31-Mar-2015",
		"rewarddetails": [{
			"rewarddtlid": "790",
			"amount": "10",
			"rewarded_date": "1-Mar-2015 10:25:13",
			"eventname": "Install",
			"friendEmail": "frnd1@gmail.com",
			"friendStoreId": null,
			"extrainfo": null,
			"status": "UnderReview"
		}, {
			"rewarddtlid": "788",
			"amount": "10",
			"rewarded_date": "1-Mar-2015 8:13:34",
			"eventname": "Install",
			"friendEmail": "frnd2@gmail.com",
			"friendStoreId": null,
			"extrainfo": null,
			"status": "UnderReview"
		}]
	}, {
		"participantid": "93701",
		"emailid": "refr2@gmail.com",
		"name": "refr2name",
		"userkey": "114589373a2f458198bc617fc3d1f434",
		"storeuserid": null,
		"campaignid": "216",
		"campaignname": "MySample",
		"eventname": null,
		"rewardid": "0",
		"reward_type": "Coupon",
		"rewarded_date": null,
		"status": "All",
		"amount": "10",
		"reward_unit": "%24",
		"couponcode": null,
		"expires": null,
		"rewarddetails": [{
			"rewarddtlid": "789",
			"amount": "10",
			"rewarded_date": "1-Mar-2015 10:18:49",
			"eventname": "Install",
			"friendEmail": "frnd3@gmail.com",
			"friendStoreId": null,
			"extrainfo": null,
			"status": "UnderReview"
		}]
	}],
	"totalrecords": "2",
	"pagenum": "1"
}
  1. Get Friend Rewards

Get the list of Friend rewards

Route

POST /v1/getfriendrewards

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • pagenum — Number of the Page. 50 records per page.
  • fromdate — Start date. Date format should be d-MMM-yyyy H:m, Timezone UTC±00 (Eg. 2-Feb-2015 2:13).
  • todate — End date to filter rewards (Eg. 2-Feb-2015 14:3).
  • status — This can be used to filter the Rewards. You can use "Rewarded" / "All" / "Suspicious" / "Rejected" / "Approved" / "UnderReview".

Status:

UnderReview — Rewards which does not met the review period.

Rewarded — Rewards which are dispatched i.e. with the status "Rewarded".

Suspicious — Rewards marked as Suspicious i.e detected by fraud detection system.

Rejected — Rejected rewards i.e Suspicious rewards can be rejected.

Approved — Rewards Approved but not yet Rewarded.

All — Rewards with all the above status. #####Sample Input:

{
"apikey":"763502957c434314b613d42400ac7a7f",
"privatekey":"8a433343ee8241a10419212415496579",
"pagenum":"1",
"fromdate":null,
"todate":"2-Feb-2015 2:13",
"status":"Approved"
}

#####Response Parameters:

  • participantid — Campaign Participant ID
  • emailid — Email of the Friend
  • name — Name of the Frined
  • userkey — Unique key to identify App User
  • storeuserid — This is the ID with which you recognize the user uniquely in your store.
  • campaignid — Unique Campaign ID
  • campaignname — Name of the Campaign
  • eventname — Install, Signup, Transaction & Any defined Custom Events
  • rewardid — Reward ID , to Track the Reward and Distribution
  • reward_type — Type of Reward (Coupon, InstoreCredits,Other)
  • rewarded_date — Reward Initiated Date
  • status — Rewarded / Suspicious / Approved / UnderReview / Rejected, lets you know state of reward.
  • amount — amount of money to reward (null when non-monetary incentive is used)
  • reward_unit — Currency Unit of the Reward
  • couponcode — Coupon code dispatched to Friend as a reward. Only when the Reward type is coupon.
  • expires — Coupon expiry date.
  • totalrecords — The total number of records(individual rewards) available in the given date time range.

#####Sample Response:

{
"rewards":[
{
"participantid":"93705",
"emailid":"frnd1@gmail.com",
"name":"frnd1name",
"userkey":"114589373a2f458198bc617fc3d1f434",
"storeuserid":null,
"campaignid":"216",
"campaignname":"MySample",
"eventname":"Signup",
"rewardid":"3324",
"reward_type":"Coupon",
"rewarded_date":"1-Mar-2015 10:25:24",
"status":"Rewarded",
"amount":"5",
"reward_unit":"$",
"couponcode":"FRIEND5",
"expires":"31-Mar-2015",
"rewarddetails":null
},
{
"participantid":"93704",
"emailid":"frnd2@gmail.com",
"name":"frnd2name",
"userkey":"6eee2f4a10204423ac940f3e20b4f7db",
"storeuserid":null,
"campaignid":"216",
"campaignname":"MySample",
"eventname":"Signup",
"rewardid":"3323",
"reward_type":"Coupon",
"rewarded_date":"1-Mar-2015 10:19:30",
"status":"Approved",
"amount":"5",
"reward_unit":"$",
"couponcode":null,
"expires":null,
"rewarddetails":null
}
],
"totalrecords":"2",
"pagenum":"1"
}
  1. Redeem Referrer Rewards

This service call helps to redeem the referrer rewards in case of "In-store Credits" or "Other" type of rewards. No need to call this method if the reward type is coupon since AppVirality system will be distributing the coupons automatically.

You can redeem the referrer reward by sending amount to be redeemed or you can send the list of "rewarddtlid" to redeem. The same amount will be deducted from referrer balance.

Route

POST /v1/redeemrewards

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • rewards — Rewards List
  • participantid — Campaign Participant ID.
  • amount — amount of money to reward (null when non-monetary incentive is used).
    (OR)
  • participantid — Campaign Participant ID.
  • rewarddetails — List of Reward Details
  • rewarddtlid — Reward detail ID, this will be generated on successful conversion(Install/Singup/Transaction..etc).

#####Sample Input 1:

Use this to redeem specific amount for a particular referrer, using participantid.

{
    "apikey": "763502957c424314b613d42400ac7a7e",
    "privatekey": "8a433343ee6241a10419212415496559",
    "rewards":[{
	  "participantid": "23234",
	  "amount": "200"            
    }]
}

#####Sample Response:

{
"success":true,
"message":""
}

#####Sample Input 2:

Use this to redeem rewards earned on a specific conversion event, using rewarddtlid.

{
"apikey":"763502957c424314b613d42400ac7a7e",
"privatekey":"8a433343ee6241a10419212415496559",
"rewards":[
{
"participantid":"34216",
"rewarddetails":[
{"rewarddtlid":"43442"
},
{
"rewarddtlid":"43432"
},
{
"rewarddtlid":"43542"
}
]} 
]}

#####Sample Response:

{
"success":true,
"message":""
}
  1. Change Reward Status

Status of the reward can be changed from server side by calling the end point "changerewardstatus".

Route

POST /v1/changerewardstatus

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • rewardslist — Rewards List
  • rewarddtlid — Reward Detail ID.
  • reward_status — Reward status can be Approved/Rejected/Suspicious/UnderReview.

#####Sample Input:

{
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"rewardslist":[
{
"rewarddtlid":"797",
"reward_status":"Approved"
}
]
}

#####Sample Response:

{
"success":true,
"message":""
}
  1. Redeem Friend Rewards

Use this call to approve Friend rewards in case of In-Store credits.

Route

POST /v1/approvereward

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • rewards — Rewards List
  • rewardid — Reward Detail ID.
  • reward_type — Reward type can be Coupon/InstoreCredits/Other.
  • status — Status can be Distribute/Reject.

#####Sample Input:

{
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"rewards":[
{
"rewardid":"797",
"reward_type":"Coupon",
"status":"Distribute"
}
]
}

#####Sample Response:

{
"success":true,
"message":""
}
  1. Get Referrer/Friend Balance

Use this call to check the referrer available balance and under review credits. If the referrer participated in multiple campaigns, it returns multiple records with reward details for each campaign.

Route

POST /v1/getuserdata

Content-Type application/json

#####Input Parameters:

  • userkey — User key for the App
  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings

#####Sample Input:

{
"userkey":"588d87d8d9e89ac5d710caf68910ac5d",
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
}

#####Response Parameters:

  • success — Response status
  • message — message if there is any for that referrer
  • userpoints — List of points
  • campaignid — Unique Campaign ID
  • participantid — Campaign Participant ID
  • total — Total Rewards for that Campaign
  • claimed — Rewards claimed for that Campaign
  • redeemable_balance — Redeemable Balance i.e. rewards which met the review period and redemption cap.
  • underreview — Rewards under review for that Campaign
  • rewardunit — Reward unit
  • redemptionthreshold — Redemption cap, it helps to let you know when to distribute the referrer reward.

#####Sample Response:

{
"success":true,
"message":null,
"userpoints":[
{
"campaignid":34,
"participantid":"93719",
"total":"10",
"claimed":"10",
"redeemable_balance":"0",
"underreview":"0",
"rewardunit":"$",
"redemptionthreshold":"0"
}
]
}
  1. Register Conversion Event

Conversion events can also be registered from server side. This helps if you don't want to send the conversion event from your App. You have to use the private key and App userkey to make this call.

Route

POST /v1/registerconversionevent

Content-Type application/json

#####Input Parameters:

  • userkey — User key for the App
  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • eventName — Install, Signup, Transaction & Any defined Custom Events
  • transactionValue — Transaction amount
  • transactionUnit — Transaction currency unit
  • extrainfo — Custom Info which is stored across the event and will be provided on query of rewards. It is generally used to save transaction information which can be used to cross check later while rewarding. Extra Info is expected in encoded Uri format.
  • tskey — Unique Integer for an Event to avoid duplicate rewards on retry. (Eg: Unix Timestamp 1453300397)

#####Sample Input:

{
	"userkey": "588d87d8d9e89ac5d710caf68910ac5d",
	"apikey": "7ffdda00fd5c4338a9c1a44e00663648",
	"privatekey": "d1e881dc60fa4856be34a44f00d96c9a",
	"eventName": "Transaction",
	"transactionValue": "250.00",
	"transactionUnit": "$",
	"extrainfo": "%7B%22OrderID%22%3A%22465%22%2C%22Ordernote%22%3A%22CashonDelivery%22%7D",
	"tskey": 1453300397
}

#####Response Parameters:

  • success — returns true on successful conversion(i.e. Referrer/Frined got rewarded).
  • message — Conversion event message if any.

#####Sample Response:

{
"success":true,
"message":null
}
  1. Update User details

This API call helps in updating App User details from server side calls. If you want to send the user details from server and not the app, generally used in case of signup using third-party credentials (Eg. Facebook, Twitter, Google etc). It is required to send private key and App userkey along with user details in order to call the update.

Route

POST /v1/updateuserinfo

Content-Type application/json

#####Input Parameters:

  • userkey — User key for the App
  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • EmailId — Email of the user.
  • AppUserName — First Name of the user, required to personalize the referral messages.
  • ProfileImage — User profile picture URL, required to personalize the referral messages.
  • UserIdInstore — ID of the user in your App(helps to identify users on dashboard as you do in your app).
  • city — City of the User Location.
  • country — Country of the User Location.
  • state — State of the User Location.
  • Phone — User phone number.
  • isExistingUser — Set this as True, if you identify the user as existing user(this is useful if you don't want to reward existing users).

#####Sample Input:

{
"userkey":"588d87d8d9e89ac5d710caf68910ac5d",
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"EmailId":"test@test.com",
"AppUserName":"MYT",
"ProfileImage":"",
"UserIdInstore":"167",
"isExistingUser":"false",
"city":"HYD",
"state":"TS",
"country":"IND",
"Phone":""
}

#####Response Parameters:

  • success — returns true on successful update.
  • message — message if any.

#####Sample Response:

{
"success":true,
"message":null
}
  1. Approve Dynamic Coupon

Use this call to approve Dynamic Coupon and send notification to user.

Route

POST /v1/approvereward

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • rewards — Rewards List
  • rewardid — Reward Detail ID.
  • reward_type — Reward type can be Coupon/InstoreCredits/Other.
  • status — Status can be Distribute/Reject.

#####Sample Input:

{
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"rewards":[
{
"rewardid":"797",
"reward_type":"Coupon",
"status":"Distribute"
}
]
}

#####Sample Response:

{
"success":true,
"message":""
}
  1. Check Reward Status

This call helps to get the current status of the Reward.

Route

POST /v1/checkrewardstatus

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • rewarddtlid — Reward Detail ID.

#####Sample Input:

{
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"rewarddtlid":"797"
}

#####Response Parameters:

  • success — Call Success Response (true/false)
  • rewarddtlid — Reward Detail ID
  • reward_status — Reward status can be Approved/Rejected/Suspicious/UnderReview/Rewarded.
  • comment — Information regarding the status change if any.

#####Sample Response:

{
"success":true,
"rewarddtlid":"797",
"reward_status":"Suspicious",
"comment":"Friend has No Email / Invalid Hardware ID"
}
  1. Get AppUser Details

Get the details of App User.

Route

POST /v1/getappuserdetails

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • userkey — User key for the App.

#####Sample Input:

{
"userkey":"588d87d8d9e89ac5d710caf68910ac5d",
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
}

#####Response Parameters:

  • success — Call Success Response (true/false)
  • message — Information regarding the status change if any.
  • userkey — Unique key to identify App User
  • deviceId — Unique Id assigned to the device.
  • EmailId — Email of the user.
  • DeviceAdvertisingId — Advertising Id assigned to Device by Google/Apple.
  • AppUserName — Name of the user.
  • FriendReferralCode — Friend's Referral Code (By whom the User is referred).
  • ReferralCode — User Referral Code.
  • UserIdInstore — ID of the user in your App(helps to identify users on dashboard as you do in your app).

#####Sample Response:

{
  "userkey": "588d87d8d9e89ac5d710caf68910ac5d",
  "deviceId": "00test0576890325442",
  "EmailId": null,
  "DeviceAdvertisingId": "7ebddcbf-50f0-4bd7-a271-b106648117b8",
  "AppUserName": "test210752name",
  "FriendReferralCode": "2def",
  "ReferralCode": "2der",
  "UserIdInstore": null,
  "success": true,
  "message": null
}
  1. Get Campaign

Get the campaign details of App based on growth hack.

Route

POST /v1/getcampaign

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • growthhack — Growth Hack Type ("Word_of_Mouth").
  • campaignid — Unique ID of a campaign generated by AppVirality.

#####Sample Input:

{
"apikey":"7b808b1f934448db8463a4c60091c49b",
"privatekey":"097262223465191eda4ec006d601b",
"growthhack":"Word_of_Mouth",
"campaignid":null
}

#####Response Parameters:

#####Sample Response:

{
    "AppCampaignsDetails": [
        {
            "AppID": 637,
            "CampaignID": 283,
            "CampaignName": "mom+grocery",
            "OfferTitle": "refer+your+friend+and+get+%3cbr%3e10+points+bla+bla",
            "OfferDescription": "get+10+Rs+if+your+friend+installs%2csignup+and+transaction",
            "CampaignStartDate": "Jul 06, 2015 12:00:00 AM",
            "CampaignTerms": "terms",
            "LaunchMessage": "text+message",
            "GrowthHackName": "Word_of_Mouth",
            "SocialActions": [
                {
                    "socialActionId": 1,
                    "socialActionName": "Facebook",
                    "sharetitle": "Referrer+link",
                    "ShareMessage": "Just+found+a+great+app!+I%27m+sure+you+will+like+it+too%3a+SHARE_URL.+Use+my+referral+code+SHARE_CODE",
                    "ShareImageURL": "",
                    "ShareURL": "",
                    "displayorder": null
                },
                {
                    "socialActionId": 3,
                    "socialActionName": "WhatsApp",
                    "sharetitle": "refer+your+friend+and+get+%3cbr%3e10+points+bla+bla",
                    "ShareMessage": "Just+found+a+great+app!+I%27m+sure+you+will+like+it+too%3a+SHARE_URL.+Use+my+referral+code+SHARE_CODE",
                    "ShareImageURL": "1growthcampaign064728-09242015e2e92.png",
                    "ShareURL": "",
                    "displayorder": null
                },
                {
                    "socialActionId": 5,
                    "socialActionName": "Mail",
                    "sharetitle": "RL",
                    "ShareMessage": "Just+found+a+great+app!+I%27m+sure+you+will+like+it+too%3a+SHARE_URL.+Use+my+referral+code+SHARE_CODE",
                    "ShareImageURL": "",
                    "ShareURL": "",
                    "displayorder": null
                },
                {
                    "socialActionId": 10,
                    "socialActionName": "Pinterest",
                    "sharetitle": "",
                    "ShareMessage": "Just+found+a+great+app!+I%27m+sure+you+will+like+it+too%3a+SHARE_URL.+Use+my+referral+code+SHARE_CODE",
                    "ShareImageURL": "http://www.planwallpaper.com/static/images/Winter-Tiger-Wild-Cat-Images.jpg",
                    "ShareURL": "",
                    "displayorder": null
                },
                {
                    "socialActionId": 14,
                    "socialActionName": "CustomLink",
                    "sharetitle": "refer+your+friend+and+get+%3cbr%3e10+points+bla+bla",
                    "ShareMessage": "customlink",
                    "ShareImageURL": "1growthcampaign064728-09242015e2e92.png",
                    "ShareURL": "",
                    "displayorder": null
                }
            ],
            "RewardRules": [
                {
                    "CampaignId": 283,
                    "RewardUserType": "Friend",
                    "EventName": "Signup",
                    "Reward": "10",
                    "RewardUnit": "points",
                    "RewardFrequency": "1",
                    "MinTranValue": "",
                    "MaxRewardAmount": ""
                },
                {
                    "CampaignId": 283,
                    "RewardUserType": "Referrer",
                    "EventName": "Signup",
                    "Reward": "10",
                    "RewardUnit": "points",
                    "RewardFrequency": "1",
                    "MinTranValue": "",
                    "MaxRewardAmount": ""
                },
                {
                    "CampaignId": 283,
                    "RewardUserType": "Referrer",
                    "EventName": "Transaction",
                    "Reward": "10",
                    "RewardUnit": "points",
                    "RewardFrequency": "0",
                    "MinTranValue": "100",
                    "MaxRewardAmount": ""
                }
            ]
        }
    ]
}
  1. Add Test Device

It helps to Add Test Device.To add test device, please click on "Add Test Device" button in AV Dashboard > Test Devices page. After clicking on button within 30 sec execute the following API.

Route

POST /v1/addtestdevice

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • DeviceID — Device ID of the Mobile.

#####Sample Input:

{
"apikey":"7b808b1f934448db8463a4c60091c49b",
"privatekey":"097262223465191eda4ec006d601b",
"deviceid":"d3e7190ac98140faa9932e89f2ba84e3"
}

#####Response Parameters:

  • success — Call Success Response (true/false)
  • message — Information regarding the status change if any.

#####Sample Response:

{
  "success": true,
  "message": null
}
  1. Reset Test Device

It helps to Reset Test Device.

Route

POST /v1/resettestdevice

Content-Type application/json

#####Input Parameters:

  • apikey — API Key of the App, get this from Dashboard > App Details
  • privatekey — Private key for API requests, get this from Dashboard > App Details > Change Settings > Advanced Settings
  • DeviceID — Device ID of the Mobile.

#####Sample Input:

{
"apikey":"7b808b1f934448db8463a4c60091c49b",
"privatekey":"097262223465191eda4ec006d601b",
"deviceid":"d3e7190ac98140faa9932e89f2ba84e3"
}

#####Response Parameters:

  • success — Call Success Response (true/false)
  • message — Information regarding the status change if any.

#####Sample Response:

{
  "success": true,
  "message": null
}

Help on other topics:

Please have a look at our Wiki page

  1. Getting Started With AppVirality Android SDK Integration
  2. AppVirality API for referral Growth Hack
  3. How to Add Test Devices & Test Referral Program
  4. Using Custom Domain
  5. Init Callback | hasReferrer | getUserKey
  6. Using Referral Code & Referral Link
  7. [Optional] Exclude Premium Users
  8. [Optional] Dynamic Share Message
  9. [Optional] Remind Later Settings
  10. [Optional] To Whom and When to Show Growth Hack
  11. [Optional] Reward Notifications or Web-hook Configuration
  12. [Optional] Android Push Notification Configuration
  13. [Optional] Personalized Welcome Screen
  14. Referral Program on Apps having Login and Logout

About

AppVirality API

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

5 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •