Relewise.Client 1.199.0

Relewise.Client

What is Relewise?

Relewise is a personalized search and recommendation engine built ground-up with relevance, performance, and flexibility as key metrics.

Relewise is generally used in commerce solutions but can be used in all types of websites and apps. By analyzing user identity and behavior as well as product and content catalog, the individual user can be given a personalized experience, which offers both a better experience and increased business value.

Elements of a commerce solution often personalized with Relewise

• Search
  • The sort order of results when a user uses the search function
  • Search term suggestions as the user types in the search field
  • Provide search despite search term spelling errors
• Recommendations
  • When a product is viewed Relewise can suggest alternative and supplementing products for up-sales
  • When the user adds a given product to the basket (the power step, products often bought with that product is presented)
  • Product and content recommendations in newsletters
• Other
  • The sort order of products when the user browses a product category
  • The sort order of items in a menu
  • Automatically triggered e-mails with content targeted to the individual user

How to get started

To get started, follow the 2 steps below...

1. Get your Dataset Id, API Key, and Server URL

To work with our services you need access to the system - more specifically a Dataset Id an API Key and a Server URL. These are all retrieved via My Relewise. Navigate to Administration → API Keys, and copy the Dataset Id, the API key, and the Server URL.

Keep in mind that different datasets will point to different servers depending on the purpose of the dataset, so you should always double check My Relewise to ensure you are pointing your calls towards the correct server.

A Note on API Keys

When you first gain access to My Relewise, you will find a single API Key available to you - the Master API Key. The Master API Key can create or delete products and content etc. so you must keep that key safely guarded. Please note that this key cannot be used to complete API calls from a browser, among other things. This is done as a safety precaution, to prevent anyone from gaining unwanted access to your dataset via a key and having immediate access to every facet of your Relewise data.

As such, when you are about to start implementing Relewise on your site, make sure to create a new API Key for each new area you want to work in, and provide it with the least necessary permissions required. By not granting more access than is minimally required, you maintain the highest level of security. You are not limited in the amount of keys you can create, and can always revoke the ones created, making it easy to maintain a high level of security.

2. Write the First Code

Write the following code to make your first Tracking

var datasetId = Guid.Parse("<DatasetId>");
var apiKeySecret = "<Your API Key>";
var serverUrl = "<Your Server URL>"
Relewise.Client.ITracker tracker = new Tracker(datasetId, apiKeySecret, serverUrl);
await tracker.TrackAsync(
   new ProductView(
       User.ByTemporaryId("<unique Id>"), //Depend on how much you know about the user
       new Product("p-1")
       )
   );

IMPORTANT NOTE: Most datakeys in Relewise are case sensitive. Ensure that your data adheres to this case sensitivity to avoid unnecessary issues during implementation. To learn more, click here.

More Examples

For hands-on examples of using the .NET package, please refer to our .NET examples page on our Documentation Page.

Tips & Tricks

1. There is also an optional Extensions-library to help configure the Relewise Client via app settings. More information about the Extensions-library can be found here.

2. We recommend that you have access to the My Relewise interface yourself, so you can see live API calls along with other helpful information about your live API calls there. To gain access to MyRelewise, simply reach out to us and request access.