UnileverRewardsConnector 1.0.2

UnileverRewardsConnector

Connector library for Unilever Rewards platform integration.

Overview

This library provides seamless integration with Unilever's Rewards platform, offering:

• Rewards Services: API client for Unilever Rewards operations
• Streaming Support: Event-driven consumers for real-time data synchronization
• Actions & Jobs: Background processing for rewards synchronization tasks
• Recurring Jobs: Scheduled operations for distributor and company data sync

Features

Services

• Complete Rewards API client with authentication
• Event outbox consumer for streaming data
• Progress tracking and sync monitoring

Actions

• Company synchronization (articles, census, points, regions, etc.)
• Distributor synchronization (accounts, points of sales, sellers)
• Campaign and sensibilization management
• TPU and EDD data synchronization

Jobs

• Census data synchronization use cases
• CSV import processing
• Progress tracking use cases

Recurring Operations

• Daily rewards processing
• Distributor scheduling (standard and advance)

Requirements

• .NET Core 3.1 or higher
• Valid Unilever Rewards API token and endpoint

Configuration

Configure the following settings in your appsettings.json:

{
  "UnileverRewardsEndpoint": "https://your-rewards-endpoint",
  "UnileverRewardsToken": "your-rewards-api-token"
}

Usage

Register services in your startup:

using Unilever;

public void ConfigureServices(IServiceCollection services)
{
    StartupServicesConfig.ConfigureServices(services, Configuration, false);
}

Inject and use the Rewards service:

public class MyController
{
    private readonly IUnileverRewardsService _rewardsService;

    public MyController(IUnileverRewardsService rewardsService)
    {
        _rewardsService = rewardsService;
    }

    public void SyncArticles()
    {
        var request = new ActionExecuteRequest
        {
            organizationCode = "YOUR_ORG_CODE"
        };

        var response = _rewardsService.UnileverRewardsActionsPost(
            NameOfJobRewards.UnileverRewardsCompanySyncArticles.ToString(),
            request
        );
    }
}

Event Streaming

The library provides event streaming capabilities through the outbox pattern:

public class MyStreamingService
{
    private readonly IUnileverRewardsService _rewardsService;

    public void ProcessEvents()
    {
        var eventsIndex = _rewardsService.GetEventsIndex();

        foreach (var index in eventsIndex)
        {
            var events = _rewardsService.GetEvents(
                index.Partition,
                index.LastProcessedId,
                50
            );

            // Process events...
        }
    }
}

Available Job Actions

• UnileverRewardsCompanyEndCampaign
• UnileverRewardsCompanyEndSensibilization
• UnileverRewardsCompanySyncArticles
• UnileverRewardsCompanySyncAxumCentralDistributor
• UnileverRewardsCompanySyncCensus
• UnileverRewardsCompanySyncCsv
• UnileverRewardsCompanySyncPoints
• UnileverRewardsCompanySyncPosClusters
• UnileverRewardsCompanySyncProgress
• UnileverRewardsCompanySyncRegions
• UnileverRewardsCompanySyncSurveyTypes
• UnileverRewardsCompanySyncTpuEdds
• UnileverRewardsDistributorSyncAccountsUsers
• UnileverRewardsDistributorSyncPointsOfSales
• UnileverRewardsDistributorSyncSellers
• UnileverRewardsCollectionCensusData

Support

For issues and questions, please contact the Unilever Rewards Team.

License

MIT