Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recommend API SDK

This is SDK for connecting with Recommend, Inc. platform. If you need any support contact support@recommend.co

Using the SDK

First, you need to obtain your API key here. When you have obtained your API key, you can use our SDK, either built from source here (from master branch) or using Nuget package. We have other integration options too - for details, please check our developer documentation.

Initializing SDK

When you have added package reference, you can initialize the SDK like this:

Recommend.SDK.APIClient client = new APIClient("your-api-key-here");

If you need to access testing environment, please contact support at email above. Initialization accepts custom URL as parameter and also you can modify exception behavior, by settingthrowExceptions=true in API constructor. By default, exceptions are handled by library but if you prefer to handle them on your own, you can do it this way, for example for logging purposes.

Referral check

To send us referral information, when conversion occurs, simply call await client.ReferralCheck("valid-rcmdn-code"). If your API key is correct and referral code is valid, you will get true response from this method call. Exception will be raised (and optionally handled by you) when parameters are incorrect or there is an issue with platform.

Troubleshooting

To validate your connection to our platform, you can use await client.TestConnection() method - this validates your API key and returns true if everything is OK. If you run into any problems, don't hesitate to contact support, we will do our best to help you.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages