Register
This API call shall allow you to register user
Use this API to register your user with AppVirality
POST
api.appvirality.com/saas/v1_0/registerapplication/jsonInput i.e. Request
{"apikey":"176502556c624614b913a62400ab4d7e","privatekey":"8b05ee42d9c941698bbba44c00cc32d1","email": "user@mail.com","name": "user name","phone":"918927266283","profileimage":"http://mywebsite.com/images/profile.png","useraccountid":"34","city":"Hyderabad","state":"Telangana","country":"India","stripecustomerid":"cus_AKNihkTMVas01Urc","existinguser":false,"usertimezone":"UTC+5:30","extrainfo":"Extra Info","referrercode":"Sr3i31"}Input Params
| Input Params | Description |
|---|---|
| apikey | API Key of the Product Get it from Dashboard › App Details |
| privatekey | Private key for API requests Get it from: Dashboard › App Details › Click App Settings › Advanced |
| email (optional) | Email of the user |
| name (optional) | Name of the Product user (is required to personalize the referral messages) If the name consists of special characters, then send the content in URI encoded format. |
| phone (optional) | User phone number (Digits only) |
| profileimage (optional) | User profile picture URL (required to personalize the referral messages) |
| useraccountid (optional) | ID of the user in your Account(helps to identify users on dashboard as you do in your product) |
| city (optional) | City of the User Location |
| state (optional) | State of the User Location |
| country (optional) | Country of the User Location |
| stripecustomerid (optional) | User’s Stripe Customer ID |
| isexistinguser (optional) | Set this as True, if you identify the user as existing user (this is useful if you don’t want to reward existing users) |
| usertimezone (optional) | Time Zone of the user |
| extrainfo (optional) | Extra information for user |
| referrercode (optional) | Referrer’s Referral Code: user will be attributed to his friend(one who invited) when on providing his referral code |
Response
{ "userkey": "176502556c624614b913a62400ab4d7e", "hasreferrer": true, "isexistinguser": false, "shareurl": "http://r.appvirality.com/mapp2fag-da", "saascampaignid": "1234", "referralcode": "mapp2fag", "referrercode":"mapp2f2s", "success": true, "message": null}Response Params
| Output Params | Description |
|---|---|
| userkey | User Key of the Product user, assigned by AppVirality - a unique identifier for every Product user recorded |
| hasreferrer | (Boolean) This will be True if the user has a referrer |
| isexistinguser | (Boolean) This will be True, if the user is identified as an already registered user/device with Appvirality |
| shareurl | Referral Link of the App user |
| referralcode | Referral Code of the Product user |
| referrercode | Referrer’s Referral Code |
| success | (Boolean) Status of the API call. This will be true when user is register successfully |
| message | Information regarding API call (if relevant) |
