Simple Referral
This is a simple referral service, You can easily generate the referral code by sending the HTTP request and other related requests, it will record your data and allocate your defined reward to the referral and referral, it also returns the rewards object for each user.
56 subscribers
9 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Simple Referral endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST |
Create Profile /profile |
Create a profile for your website, product or app, You can generate as much profile as you need. Each profile will have a unique ID, this ID should be send with all requests. |
| PUT |
Edit Profile /profile |
Use it if you want to edit your profile info. You will only be able to change the username and password. Old username and password sent as a basic authentication header and new… |
| POST |
Define Rewards /define-rewards |
We have two rewards, one for referrer ( the person who refer someone else ) and one for referred ( person who use a referral code ). If you do not define a reward, the "0" value… |
| GET |
Get Rewards /{id}/get-rewards |
You can get your defined rewards using this route |
| POST |
Generate Referral Code /generate-referral-code |
Send unique ID and generate or retrieve their referral code |
| GET |
Get List of Allocated Rewards /referral/rewards/{id}/{userReferralCode} |
Return the list of the Rewards that allocated to one user. |
| POST |
Submit Referral Code /submit-referral-code |
Submit referral code to get reward. Rewards will allocate to the referrer and referred automatically |
| PUT |
Edit User /user/{userId} |
If you want to add reward manually or change the status user, you can use the edit endpoint. |
| DELETE |
Delete User /user/{userId} |
If you want to delete a user from your userbase. delete the user do not delete the reward allocate to other users who used this user referral code. |
Simple Referral pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO | $10 / month | 1000 / minute |
|
| ULTRA Recommended | $25 / month | — |
|
