# Refer a Friend V3 APIs

Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below.

Version: 3.0.1

## Servers

```
https://s2.socialannex.net/api/
```

## Download OpenAPI description

[Refer a Friend V3 APIs](https://annexcloud.redocly.app/_bundle/raf/raf.yaml)

## User

Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below.

### Create a new user account under a specific site

 - [POST /createuser/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/user/invitecodecoupon.md): This POST endpoint allows you to create a new user account under a specific site.

### Get referral status

 - [POST /Referralstatus/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/user/invitecode.md): This API is used to get the referral status of the referee (the friend who was referred by a member).

### Create or Assign a new invite code coupon for a specific site

 - [POST /Invitecodecoupon/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/user/invitecodecoupon.md): This API is used to unlock the coupon code for the referee/friend.

### Retrive the sharer email address

 - [POST /userinformation/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/user/getshareremail.md): This API is used to get member information registered in the RAF module by providing an email address and incentive ID.

### Get referrer's details

 - [POST /userinvitecodedetail/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/user/invitecodedetail.md): This API is used to get the referrer’s details through the stat ID and invite code.

## Refer

Referral Marketing Program creates a channel for your customers to share your brand with their friends and family. From social media integration to email, and in-person recommendations you can proactively cultivate referrals anywhere, and comprehensive reporting helps you track and optimize your various referral channels. Most of the consumers trust recommendations from friends and family more than other forms of advertising. Refer a Friend enables you to organically grow your customer base by giving your loyal shoppers a platform to advocate for your brand. This API is used to send email invitations to members' friends and to get bitly against the specific social type (i.e., Facebook, Twitter & SMS sharing). A detailed explanation of RAF Refer API and the examples are shown below.

### Create bitly links

 - [POST /Createbitly/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/refer/createbitly.md): This API is used to create bitly links for specific member’s Facebook, Twitter, and Email Sharing.

### Send e-mail to friends

 - [POST /Sendemail/{{siteId}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/refer/referralstatus.md): This API is used to trigger invitation emails to friends.

## Reward

Referral Marketing Program creates a channel for your customers to share your brand with their friends and family. From social media integration to email, and in-person recommendations you can proactively cultivate referrals anywhere, and comprehensive reporting helps you track and optimize your various referral channels. Customers who share your brand with their friends and family can earn good rewards. These rewards are in terms of various coupon codes and gift vouchers. This API is used to provide coupon codes, claim and manage earned rewards. A detailed explanation of RAF Reward API and the examples are shown below.

### Generate a coupon code for an invitee using a referral invite code

 - [POST /Invitecodecoupon/{{site_id}}?access_token={{access_token}}](https://annexcloud.redocly.app/raf/raf/reward/invitecouponsiteidaccesstoken.md): This endpoint is used to generate and assign a coupon code to a referred user (invitee) based on a valid referral invite code.