CL.Campaign.SDK 1.0.0

CL.Campaign.SDK

Official .NET SDK for CL Campaign API. Provides easy integration for external systems to query cart promotions with built-in validation, preprocessing, and caching capabilities.

Features

• 🚀 Easy integration with CL Campaign API
• 🔒 Built-in authentication (JWT Token or API Key)
• ⚡ Automatic caching and performance optimization
• ✅ Input validation and preprocessing
• 🏢 Multi-tenant support
• 📦 Lightweight and dependency-free

Installation

dotnet add package CL.Campaign.SDK

Quick Start

// 1. Add SDK to your services
services.AddCampaignSdk(options =>
{
    options.BaseUrl = "https://your-api-url.com";
    options.TenantId = "your-tenant-id";
    options.ApiKey = "your-api-key";
    options.ApiSecret = "your-api-secret";
    options.UseApiKeyAuth = true;
});

// 2. Inject and use the service
public class MyService
{
    private readonly ICampaignService _campaignService;
    private readonly IEngineService _engineService;

    public MyService(ICampaignService campaignService, IEngineService engineService)
    {
        _campaignService = campaignService;
        _engineService = engineService;
    }

    public async Task<PromotionResultModel> ApplyPromotions(CartModel cart)
    {
        var cartRequest = new CartRequest { Cart = cart };
        var result = await _engineService.ExecuteCampaignsAsync(cartRequest);
        return result.Data;
    }
}

Configuration

Authentication Options

// JWT Token Authentication
options.JwtToken = "your-jwt-token";

// API Key Authentication
options.UseApiKeyAuth = true;
options.ApiKey = "your-api-key";
options.ApiSecret = "your-api-secret";

Caching Options

options.EnableResponseCaching = true;
options.CacheDurationSeconds = 300; // 5 minutes

API Reference

ICampaignService

• GetCampaignsAsync() - Get all campaigns
• GetCampaignAsync(id) - Get specific campaign
• CreateCampaignAsync(campaign) - Create new campaign
• UpdateCampaignAsync(id, campaign) - Update campaign
• DeleteCampaignAsync(id) - Delete campaign
• ToggleCampaignStatusAsync(id) - Toggle campaign status

IEngineService

• ExecuteCampaignsAsync(cartRequest) - Apply promotions to cart
• TestCampaignsAsync(cartRequest) - Test promotions without applying
• GetAvailableCampaignsAsync(customerId) - Get available campaigns for customer

Examples

Basic Cart Promotion

var cart = new CartModel
{
    Customer = new CustomerModel { Id = "customer-123" },
    Lines = new List<CartLineModel>
    {
        new CartLineModel
        {
            ProductId = "product-1",
            Quantity = 2,
            UnitPrice = 100
        }
    }
};

var cartRequest = new CartRequest { Cart = cart };
var result = await _engineService.ExecuteCampaignsAsync(cartRequest);

if (result.Success)
{
    Console.WriteLine($"Total Discount: {result.Data.TotalDiscount}");
    Console.WriteLine($"Final Total: {result.Data.FinalTotal}");
}

Campaign Management

// Get all campaigns
var campaigns = await _campaignService.GetCampaignsAsync();

// Create new campaign
var newCampaign = new CampaignModel
{
    Name = "Summer Sale",
    Description = "20% off all summer items",
    Status = true
};

var created = await _campaignService.CreateCampaignAsync(newCampaign);

License

MIT License - see LICENSE file for details.

Support

For support and questions:

• GitHub Issues: Create an issue
• Documentation: Wiki
• Email: support@commercelab.com