Summary

We, at Annex Cloud, are a leading software company specializing in delivering comprehensive customer loyalty solutions, referral marketing platforms, and customer retention tools. Our core offering, the Loyalty Experience Platform, is a robust cloud-based software suite designed to help businesses cultivate and nurture customer loyalty. Through our platform, companies can effectively manage loyalty programs, incentivize repeat purchases, and personalize customer experiences to foster long-term engagement and brand loyalty.

The integration of Annex Cloud loyalty with BazaarVoice provides a comprehensive solution for rewarding customers based on moderated reviews.

Annex Cloud retrieves the latest moderated data from BazaarVoice. When a customer purchases a product, they typically write a review on the retailer's website. This review data is sent to BazaarVoice using their available APIs, after which Annex Cloud pulls the moderated data from BazaarVoice.

Annex Cloud then validates customers' loyalty and awards points based on the approved moderated data.

Pre-requisites

1. Client's conversation API key - To retrieve member data.
2. Client's shared secret API key - To decrypt email addresses.

Configuration with Annex Cloud

Site Administrator Instructions:

• Enable the Ratings and Review action. 
  • Navigate to the Actions section.
  • Select Create new Action.
  • From the list of available actions, choose Ratings and Reviews.
  • Enter the number of points that members will earn for completing this action.
  • Save the advanced settings.

Configuration in Bazaarvoice Admin 

You need to follow the following process before sending the members' data to the Annex Cloud database to award points.

• Log in to BazaarVoice’s instance.
• Select the Workbench option from the menu, as shown below:
  
• Choose one of the two available options from the drop-down list: annexcloud (STAGING) or annexcloud (PRODUCTION).
  
• Navigate through the instance to check the Dashboards, Reports, Alerts, and Resources. The administrator can create and manage reports, analyze content trends, and view key performance indicators. Below is an image of what BazaarVoice's staging environment looks like:
  
• To manage content, click the Content tab and select Ratings & Reviews in the Manage Content section.
  
• After clicking on Ratings & Reviews, all members' ratings and reviews will be displayed as illustrated in the image below.
  
• The administrator has the option to approve or reject each review. Additionally, the administrator can respond to the review and, if needed, email the review to multiple stakeholders.
  
• The administrator can view a member's review in detail by clicking the Show Detail icon, as shown in the image below.
  
• The image below shows the review selected above in detail.
  

Annex Cloud Configuration to Pull the Moderated Data 

1. You can use this method to retrieve members' data from the Bazaarvoice conversation API by providing the following details:
   • API Endpoint - https://stg.api.bazaarvoice.com/data/reviews.json?apiversion=5.4
   • API Key – XXXXXXXXXXXXX (Provided by Annex Cloud)
   • Method - GET 
   • Response - Once you execute the API, the following responses are retrieved:

{ 
    "Limit": 10, 
    "Offset": 0, 
    "Total Results": 68, 
    "Locale": "en_US", 
    "Results": [ 
        { 
            "Id": "46082471", 
            "CID": "173ba849-6e4a-5d9a-b76f-fdbef8c81af6", 
            "SourceClient": "test-annexcloud", 
            "LastModeratedTime": "2023-04-04T11:00:02.000+00:00", 
            "LastModificationTime": "2023-04-04T11:00:02.000+00:00", 
            "ProductId": "demo-product-1", 
            "AuthorId": "me439vw65lljz6fdkvmfrwotf", 
            "ContentLocale": "en_US", 
            "IsFeatured": false, 
            "TotalInappropriateFeedbackCount": 0, 
            "TotalClientResponseCount": 0, 
            "TotalCommentCount": 0, 
            "Rating": 5, 
            "IsRatingsOnly": true, 
            "TotalFeedbackCount": 0, 
            "TotalNegativeFeedbackCount": 0, 
            "TotalPositiveFeedbackCount": 0, 
            "ModerationStatus": "APPROVED", 
            "SubmissionId": "r210553_1__16806059bEVJERkpKo", 
            "SubmissionTime": "2023-04-04T10:58:36.000+00:00", 
            "UserNickname": "jimmy sinek", 
            "UserEmailAddress": "0eGkCOLTAjRxwM38N8Qg/p7Z7ruhbxjJfcQKxzURlHs=", 
            "ReviewText": null, 
            "SecondaryRatingsOrder": [], 
            "AdditionalFields": {}, 
            "Badges": {}, 
            "Photos": [], 
            "InappropriateFeedbackList": [], 
            "ProductRecommendationIds": [], 
            "ContextDataValues": {}, 
            "Pros": null, 
            "SecondaryRatings": {}, 
            "UserLocation": null, 
            "CommentIds": [], 
            "IsSyndicated": false, 
            "AdditionalFieldsOrder": [], 
            "CampaignId": null, 
            "Title": null, 
            "ContextDataValuesOrder": [], 
            "Helpfulness": null, 
            "TagDimensions": {}, 
            "RatingRange": 5, 
            "BadgesOrder": [], 
            "IsRecommended": null, 
            "ClientResponses": [], 
            "Cons": null, 
            "TagDimensionsOrder": [], 
            "Videos": [] 
        } 
] 
}

2. The following conditions must be set to take the data:
   • ModerationStatus = APPROVED (Equal To) 
   • LastModeratedTime != TodaysDate (Not Equal To) 

Only data with an approved moderation status will be retrieved.

3. After applying the conditions mentioned above, extract the encoded email from the filtered data. Use the client decryption code to decode it and verify whether the member’s email address is opted in. If the customer is not opted in, their data cannot be retrieved.

API to Retrieve Member details

This API method is used to fetch all the information for a loyalty member by passing the unique ID of the member.

• Method- GET: /users/{{memberId}}
• Function Location In Extension- ANNEXCLOUDV3SERVICE 

Response:

Upon providing the unique member ID in the request body, the following parameters will be displayed in the response:

Sample Positive Response:

Sample Error Response: 

Process to Award Points to Members

If a member is found in the above API, points are awarded to them using the APIs listed below.

• API- https://s15.socialannex.net/api/3.0/points 
• Method- POST 
• Request Object- Not Blank 
• Function Location in Extension- ANNEXCLOUDV3SERVICE 

To Award Points

To Redeem Rewards

To Redeem Custom Points

To Award or Deduct Custom Points from a member’s account.

Custom points are not predefined in the system; instead, they are set and managed based on specific member-defined criteria or rules. These points can be awarded or deducted according to custom parameters.

Sample Request: 

Response: 

This provides a successful response detailing the points added or redeemed from the member's account.

To give points: 
{ 
  "id": "user@domain.com", 
  "actionId": "100", 
  "activity": "CREDIT", 
  "reason": "aj Bonus" 
  "credit": "50" 
} 
To redeem points: 
{ 
  "id": "user@domain.com", 
  "rewardId": "111", 
  "activity": "DEBIT", 
  "orderId": "OD001", 
  "reason": "claim" 
  "source": "web" 
}  
To redeem custom points: 
{ 
  "id": "user@domain.com", 
  "activity": "DEBIT", 
  "orderId": "OD001", 
  "debit": "500", 
  "reason": "used for purchase" 
  "source": "web" 
} 
To award custom points: 
{ 
  "id": "user@domain.com", 
  "actionId": "100", 
  "activity": "CREDIT", 
  "credit": "50", 
  "reason": "bonus" 
} 
To deduct custom points: 
{ 
  "id": "user@domain.com", 
  "actionId": "100", 
  "activity": "DEBIT", 
  "orderId": "OD001", 
  "debit": "50", 
  "reason": "adjustment" 
}

Response:

Sample Error Response: 

Functional Flow Diagram